Skip to content

Commit 13575bd

Browse files
anarnold97anarnold97
committed
MTA-4161: MTA flags are missing in the documentation
Signed-off-by: A.Arnold <[email protected]>
1 parent 2192053 commit 13575bd

File tree

2 files changed

+118
-144
lines changed

2 files changed

+118
-144
lines changed

‎docs/cli-guide/master.adoc

Lines changed: 1 addition & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -102,38 +102,8 @@ include::topics/mta-optimize-performance.adoc[leveloffset=+1]
102102
// Configure {ProductShortName} to Exclude Files and Packages
103103
// include::topics/mta-exclude-files-and-packages.adoc[leveloffset=+2]
104104

105-
[appendix]
106-
== Reference material
107105

108106
// {ProductShortName} Command-line Arguments
109107
include::topics/mta-cli-args.adoc[leveloffset=+2]
110108

111-
// Added in 4.3.0: list of supported Tech Tags
112-
include::topics/tech-tags.adoc[leveloffset=+2]
113-
114-
// Rule Story Points
115-
include::topics/about-story-points.adoc[leveloffset=+2]
116-
117-
For more information on categorizing tasks, see link:{ProductDocRulesGuideURL}/rule_categories_rules-development-guide#rule_categories_rules-development-guide[Using custom rule categories].
118-
119-
=== Additional Resources
120-
121-
// Get Involved
122-
include::topics/get-involved.adoc[leveloffset=+3]
123-
124-
// Important Links
125-
include::topics/important-links.adoc[leveloffset=+3]
126-
127-
// Report Issues with {ProductShortName}
128-
129-
==== Reporting issues
130-
131-
{ProductShortName} uses Jira as its issue tracking system. If you encounter an issue executing {ProductShortName}, submit a link:{JiraWindupURL}[Jira issue].
132-
133-
// **********************************
134-
// * Appendix: Revision Information *
135-
// **********************************
136-
include::topics/templates/revision-info.adoc[]
137-
138-
139-
109+
:!cli-guide:

‎docs/topics/mta-cli-args.adoc

Lines changed: 117 additions & 113 deletions
Original file line numberDiff line numberDiff line change
@@ -2,138 +2,164 @@
22
//
33
// * docs/cli-guide/master.adoc
44

5-
:_mod-docs-content-type: REFERENCE
5+
:_content-type: REFERENCE
66
[id="cli-args_{context}"]
77
= About {ProductShortName} command-line arguments
88

99
The following is a detailed description of the available {ProductShortName} command line arguments.
1010

1111
[NOTE]
1212
====
13-
To run the {ProductShortName} command, for example when executing from a script, you must use the following arguments:
13+
To run the {ProductShortName} command without prompting, for example when executing from a script, you must use the following arguments:
1414
15+
* `--batchMode`
1516
* `--overwrite`
1617
* `--input`
1718
* `--target`
1819
====
1920

20-
2121
.{ProductShortName} CLI arguments
2222
[cols="40%,60%a",options="header",]
23+
[width="100%",cols="30%,30%,65%",options="header",]
2324
|====
24-
|Argument |Description
25-
|--analyze-known-libraries | Flag to analyze known software artifacts embedded within your application. By default, {ProductShortName} only analyzes application code.
25+
|Command |Type|Description
2626

27-
[NOTE]
28-
====
29-
This option might result in a longer execution time and a large number of migration issues being reported.
30-
====
27+
a|`--analyze-known-libraries`
28+
|
29+
|Flag to analyze known open-source libraries.
3130

32-
|--help |Display the {ProductShortName} help message.
33-
|--input |A space-delimited list of the path to the file or directory containing one or more applications to be analyzed. This argument is required.
34-
| --list-sources
35-
| list rules for available migration sources
36-
|--list-sources | Flag to list all available source technologies.
37-
|--list-targets| Flag to list all available target technologies.
38-
|--output |Specify the path to the directory to output the report information generated by {ProductShortName}.
31+
a|`--bulk`
32+
|
33+
a|Flag for running multiple analyze commands in bulk, which result in a combined static report.
3934

40-
[IMPORTANT]
41-
====
42-
Do not overwrite a report output directory that contains important information.
43-
====
44-
| --rules stringArray | Filename or directory containing rule files
45-
| --source |A space-delimited list of one or more source technologies, servers, platforms, or frameworks to migrate from. This argument, in conjunction with the `--target` argument, helps to determine which rulesets are used. Use the `--listSourceTechnologies` argument to list all available sources.
46-
|--target |A space-delimited list of one or more target technologies, servers, platforms, or frameworks to migrate to. This argument, in conjunction with the `--source` argument, helps to determine which rulesets are used. Use the `--list-targets` argument to list all available targets.
47-
|====
35+
|`--context-lines`
36+
|Integer
37+
|Flag to define the number of lines of source code to include in the output for each incident (default: `100`).
4838

49-
[id="cli-input-argument_{context}"]
50-
== Specifying the input
39+
a|`-d`, `–dependency-folders`
40+
|String Array
41+
|Flag for the directory for dependencies.
5142

52-
A space-delimited list of the path to the file or directory containing one or more applications to be analyzed. This argument is required.
43+
a|`--enable-default-rulesets`
44+
|Boolean
45+
a|Flag to run default rulesets with analysis (default: `true`).
5346

54-
.Usage
55-
[source,options="nowrap",subs="attributes+"]
56-
----
57-
--input <INPUT_ARCHIVE_OR_DIRECTORY> [...]
58-
----
47+
a|`-h`, `–help`
48+
|
49+
|Flag to output help for analyze
5950

60-
[id="cli-input-file-type-arguments_{context}"]
61-
== Analyze application source code
51+
a|`--incident-selector`
52+
|String
53+
a|Flag to select incidents based on custom variables, for example, `!package=io.konveyor.demo.config-utils`
6254

63-
Usage: `{mta-cli} analyze [flags]`
55+
a|`-i`, `–input`
56+
|String
57+
a|Flag for the path to application source code or a binary. For more details, see xref:cli-input-argument_cli-guide[Specifying the input].
6458

65-
The following flags are available:
59+
a|`--jaeger-endpoint`
60+
|String
61+
|Flag for the jaeger endpoint to collect traces.
6662

67-
.{ProductShortName} Analyze application
68-
[cols="40%,60%a",options="header",]
69-
|====
70-
|Flag |Description
63+
a|`--json-output`
64+
|
65+
a|Flag to create analysis and dependency output as JSON.
7166

72-
| --analyze-known-libraries
73-
| analyze known open source libraries
67+
a|`--list-sources`
68+
|
69+
a|Flag to list rules for available migration sources.
7470

75-
| -h, --help
76-
| help for analyze
71+
a|`--list-targets`
72+
|
73+
|Flag to list rules for available migration targets.
7774

78-
| -i, --input string
79-
| path to application source code or a binary
75+
a|`--list-providers`
76+
|
77+
|Flag to list available supported providers.
8078

81-
| --json-output
82-
| create analysis and dependency output as JSON
79+
a|`-l`, `--label-selector`
80+
|String
81+
|Flag to run rules based on a specified label selector expression.
8382

84-
| --list-sources
85-
| list rules for available migration sources
83+
a|`--maven-settings`
84+
|string
85+
|Flag path to a custom Maven settings file to use
8686

87-
| --list-targets
88-
| list rules for available migration targets
87+
a|`--overwrite`
88+
|
89+
|Flag to overwrite the output directory. If you do not specify this argument and the `--output` directory exists, you are prompted to choose whether to overwrite the contents.
8990

90-
| -l, --label-selector string
91-
| run rules based on specified label selector expression
91+
a|`--skip-static-report`
92+
|
93+
|Flag to not generate static report.
9294

93-
| --maven-settings string
94-
| path to a custom maven settings file to use
95+
a|`-m`, `--mode`
96+
|String
97+
a|Flag for analysis mode, this must be one of `full`, for `source` and `dependencies`, or `source-only` (default `full`)
9598

96-
| --overwrite
97-
| overwrite output directory
99+
a|`-o`, `--output`
100+
|String
101+
|Flag for the path to the directory for analysis output. For more details, see xref:cli-output-argument_cli-guide[Specifying the output directory].
98102

99-
| --skip-static-report
100-
| do not generate static report
103+
a|`--override-provider-settings`
104+
|String
105+
|Flag to override the provider settings, the analysis pod runs on the host network, and no providers are started up.
101106

102-
| -m, --mode string
103-
| analysis mode" `full` (default) or `source-only`
107+
a|`--provider`
108+
|String Array
109+
|Flag to specify which provider or providers to run.
104110

105-
| -o, --output string | path to the directory for analysis output
111+
a|`--rules`
112+
|String Array
113+
a|Flag to specify the filename or directory containing rule files. Use multiple times for additional rules: `--rules --rules …`
106114

107-
| --rules stringArray | filename or directory containing rule files
115+
a|`-s`, `--source`
116+
|String Array
117+
a|Flag for the source technology to consider for analysis. Use multiple times for additional sources: `--source --source …`. For more details, see xref:cli-source-argument_cli-guide[Setting the source technology].
108118

109-
| --skip-static-report
110-
| do not generate static report
119+
a|`-t`, `--target`
120+
|String Array
121+
a|Flag for the target technology to consider for analysis. Use multiple times for additional targets: `--target --target …`. For more details, see xref:cli-target-argument_cli-guide[Setting the target technology].
122+
|====
111123

112-
| -s, --source string
113-
| source technology to consider for analysis. To specify multiple sources, repeat the parameter: --source <source_1> --source <source_2> etc.
114124

115-
| -t, --target string
116-
| target technology to consider for analysis. To specify multiple targets, repeat the parameter: --target <target_1> --target <target_2> etc.
117-
|====
125+
[id="cli-input-argument_{context}"]
126+
== Specifying the input
118127

119-
[id="cli-input-file-type-arguments-global-flags_{context}"]
120-
=== Global flags
128+
A space-delimited list of the path to the file or directory containing one or more applications to be analyzed. This argument is required.
121129

122-
.{ProductShortName} Analyze application
123-
[cols="40%,60%a",options="header",]
124-
|====
130+
.Usage
131+
[source,options="nowrap",subs="attributes+"]
132+
----
133+
--input <INPUT_ARCHIVE_OR_DIRECTORY> [...]
134+
----
125135

126-
|Flag
127-
|Description
136+
Depending on whether the input file type provided to the `--input` argument is a file or directory, it will be evaluated as follows depending on the additional arguments provided.
128137

129-
| --log-level uint32
130-
| log level (default 4)
138+
Directory::
139+
+
140+
[cols="1,1,1",options="header"]
141+
|====
142+
| --explodedApp
143+
| --sourceMode
144+
| Neither Argument
131145

132-
| --no-cleanup
133-
| do not clean up temporary resources
146+
| The directory is evaluated as a single application.
147+
| The directory is evaluated as a single application.
148+
| Each subdirectory is evaluated as an application.
134149
|====
135150

151+
File::
152+
+
153+
[cols="1,1,1",options="header"]
154+
|====
155+
| --explodedApp
156+
| --sourceMode
157+
| Neither Argument
136158

159+
| Argument is ignored; the file is evaluated as a single application.
160+
| The file is evaluated as a compressed project.
161+
| The file is evaluated as a single application.
162+
|====
137163

138164
[id="cli-output-argument_{context}"]
139165
== Specifying the output directory
@@ -146,39 +172,40 @@ Specify the path to the directory to output the report information generated by
146172
--output <OUTPUT_REPORT_DIRECTORY>
147173
----
148174

149-
* The `--output` argument is mandatory. If omitted, an error is returned:
175+
* If omitted, the report will be generated in an `<INPUT_ARCHIVE_OR_DIRECTORY>.report` directory.
176+
* If the output directory exists, you will be prompted with the following (with a default of N).
150177
+
151178
[source,options="nowrap",subs="attributes+"]
152179
----
153-
Error: required flag(s) "output" not set
180+
Overwrite all contents of "/home/username/<OUTPUT_REPORT_DIRECTORY>" (anything already in the directory will be deleted)? [y,N]
154181
----
155182

156-
However, if you specify the `--overwrite` argument, {ProductShortName} will proceed to delete and re-create the directory. See the description of this argument for more information.
183+
However, if you specify the `--overwrite` argument, {ProductShortName} will proceed to delete and recreate the directory. See the description of this argument for more information.
157184

158185
[id="cli-source-argument_{context}"]
159186
== Setting the source technology
160187

161-
A space-delimited list of one or more source technologies, servers, platforms, or frameworks to migrate from. This argument, in conjunction with the `--target` argument, helps to determine which rulesets are used. Use the `--list-sources` argument to list all available sources.
188+
A space-delimited list of one or more source technologies, servers, platforms, or frameworks to migrate from. This argument, in conjunction with the `--target` argument, helps to determine which rulesets are used. Use the `--listSourceTechnologies` argument to list all available sources.
162189

163190
.Usage
164191
[source,options="nowrap",subs="attributes+"]
165192
----
166193
--source <SOURCE_1> <SOURCE_2>
167194
----
168195

169-
The `--source` argument now provides version support, which follows the link:http://maven.apache.org/enforcer/enforcer-rules/versionRanges.html[Maven version range syntax]. This instructs {ProductShortName} to only run the rulesets matching the specified versions. For example, `--source eap5`.
196+
The `--source` argument now provides version support, which follows the link:http://maven.apache.org/enforcer/enforcer-rules/versionRanges.html[Maven version range syntax]. This instructs {ProductShortName} to only run the rulesets matching the specified versions. For example, `--source eap:5`.
170197

171198
[WARNING]
172199
====
173-
When migrating to JBoss EAP, be sure to specify the version, for example, `eap6`. Specifying only `eap` will run rulesets for all versions of JBoss EAP, including those not relevant to your migration path.
200+
When migrating to JBoss EAP, be sure to specify the version, for example, `eap:6`. Specifying only `eap` will run rulesets for all versions of JBoss EAP, including those not relevant to your migration path.
174201
175202
See link:{ProductDocIntroToMTAGuideURL}/index#migration_paths_getting-started-guide[Supported migration paths] in _{IntroToMTABookName}_ for the appropriate JBoss EAP version.
176203
====
177204

178205
[id="cli-target-argument_{context}"]
179206
== Setting the target technology
180207

181-
A space-delimited list of one or more target technologies, servers, platforms, or frameworks to migrate to. This argument, in conjunction with the `--source` argument, helps to determine which rulesets are used. If you do not provide a target, mta-cli analyzes the input based on the source and discovery rules. Use the `--list-targets` argument to list all available targets.
208+
A space-delimited list of one or more target technologies, servers, platforms, or frameworks to migrate to. This argument, in conjunction with the `--source` argument, helps to determine which rulesets are used. If you do not specify this option, you are prompted to select a target. Use the `--listTargetTechnologies` argument to list all available targets.
182209

183210
.Usage
184211
[source,options="nowrap",subs="attributes+"]
@@ -187,27 +214,4 @@ A space-delimited list of one or more target technologies, servers, platforms, o
187214
----
188215

189216

190-
The `--target` argument now provides version support, which follows the link:http://maven.apache.org/enforcer/enforcer-rules/versionRanges.html[Maven version range syntax]. This instructs {ProductShortName} to only run the rulesets matching the specified versions. For example, `--target eap7`.
191-
192-
[WARNING]
193-
====
194-
When migrating to JBoss EAP, be sure to specify the version in the target, for example, `eap6`. Specifying only `eap` will run rulesets for all versions of JBoss EAP, including those not relevant to your migration path.
195-
196-
See link:{ProductDocIntroToMTAGuideURL}/index#migration_paths_getting-started-guide[Supported migration paths] in _{IntroToMTABookName}_ for the appropriate JBoss EAP version.
197-
====
198-
199-
////
200-
[id="cli-packages-argument_{context}"]
201-
== Selecting packages
202-
203-
A space-delimited list of the packages to be evaluated by {ProductShortName}. It is highly recommended to use this argument.
204-
205-
.Usage
206-
[source,options="nowrap",subs="attributes+"]
207-
----
208-
----
209-
210-
* In most cases, you are interested only in evaluating custom application class packages and not standard Java EE or third party packages. The `<PACKAGE_N>` argument is a package prefix; all subpackages will be scanned. For example, to scan the packages `com.mycustomapp` and `com.myotherapp`, use `--packages com.mycustomapp com.myotherapp` argument on the command line.
211-
* While you can provide package names for standard Java EE third party software such as `org.apache`, it is usually best not to include them as they should not impact the migration effort.
212-
213-
////
217+
The `--target` argument now provides version support, which follows the link:http://maven.apache.org/enforcer/enforcer-rules/versionRanges.html[Maven version range syntax]. This instructs {ProductShortName} to only run the rulesets matching the specified versions. For example, `--target eap:7`.

0 commit comments

Comments
 (0)