From 13575bdeb69d6f176a7a215dda36b9b033756561 Mon Sep 17 00:00:00 2001 From: "A.Arnold" Date: Sun, 3 Nov 2024 19:10:45 +0000 Subject: [PATCH 01/25] MTA-4161: MTA flags are missing in the documentation Signed-off-by: A.Arnold --- docs/cli-guide/master.adoc | 32 +---- docs/topics/mta-cli-args.adoc | 230 +++++++++++++++++----------------- 2 files changed, 118 insertions(+), 144 deletions(-) diff --git a/docs/cli-guide/master.adoc b/docs/cli-guide/master.adoc index 65d19b83..f023c617 100644 --- a/docs/cli-guide/master.adoc +++ b/docs/cli-guide/master.adoc @@ -102,38 +102,8 @@ include::topics/mta-optimize-performance.adoc[leveloffset=+1] // Configure {ProductShortName} to Exclude Files and Packages // include::topics/mta-exclude-files-and-packages.adoc[leveloffset=+2] -[appendix] -== Reference material // {ProductShortName} Command-line Arguments include::topics/mta-cli-args.adoc[leveloffset=+2] -// Added in 4.3.0: list of supported Tech Tags -include::topics/tech-tags.adoc[leveloffset=+2] - -// Rule Story Points -include::topics/about-story-points.adoc[leveloffset=+2] - -For more information on categorizing tasks, see link:{ProductDocRulesGuideURL}/rule_categories_rules-development-guide#rule_categories_rules-development-guide[Using custom rule categories]. - -=== Additional Resources - -// Get Involved -include::topics/get-involved.adoc[leveloffset=+3] - -// Important Links -include::topics/important-links.adoc[leveloffset=+3] - -// Report Issues with {ProductShortName} - -==== Reporting issues - -{ProductShortName} uses Jira as its issue tracking system. If you encounter an issue executing {ProductShortName}, submit a link:{JiraWindupURL}[Jira issue]. - -// ********************************** -// * Appendix: Revision Information * -// ********************************** -include::topics/templates/revision-info.adoc[] - - - +:!cli-guide: diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index 2ff7ddc0..23469604 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -2,7 +2,7 @@ // // * docs/cli-guide/master.adoc -:_mod-docs-content-type: REFERENCE +:_content-type: REFERENCE [id="cli-args_{context}"] = About {ProductShortName} command-line arguments @@ -10,130 +10,156 @@ The following is a detailed description of the available {ProductShortName} comm [NOTE] ==== -To run the {ProductShortName} command, for example when executing from a script, you must use the following arguments: +To run the {ProductShortName} command without prompting, for example when executing from a script, you must use the following arguments: +* `--batchMode` * `--overwrite` * `--input` * `--target` ==== - .{ProductShortName} CLI arguments [cols="40%,60%a",options="header",] +[width="100%",cols="30%,30%,65%",options="header",] |==== -|Argument |Description -|--analyze-known-libraries | Flag to analyze known software artifacts embedded within your application. By default, {ProductShortName} only analyzes application code. +|Command |Type|Description -[NOTE] -==== -This option might result in a longer execution time and a large number of migration issues being reported. -==== +a|`--analyze-known-libraries` +| +|Flag to analyze known open-source libraries. -|--help |Display the {ProductShortName} help message. -|--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. -| --list-sources -| list rules for available migration sources -|--list-sources | Flag to list all available source technologies. -|--list-targets| Flag to list all available target technologies. -|--output |Specify the path to the directory to output the report information generated by {ProductShortName}. +a|`--bulk` +| +a|Flag for running multiple analyze commands in bulk, which result in a combined static report. -[IMPORTANT] -==== -Do not overwrite a report output directory that contains important information. -==== -| --rules stringArray | Filename or directory containing rule files -| --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. -|--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. -|==== +|`--context-lines` +|Integer +|Flag to define the number of lines of source code to include in the output for each incident (default: `100`). -[id="cli-input-argument_{context}"] -== Specifying the input +a|`-d`, `–dependency-folders` +|String Array +|Flag for the directory for dependencies. -A space-delimited list of the path to the file or directory containing one or more applications to be analyzed. This argument is required. +a|`--enable-default-rulesets` +|Boolean +a|Flag to run default rulesets with analysis (default: `true`). -.Usage -[source,options="nowrap",subs="attributes+"] ----- ---input [...] ----- +a|`-h`, `–help` +| +|Flag to output help for analyze -[id="cli-input-file-type-arguments_{context}"] -== Analyze application source code +a|`--incident-selector` +|String +a|Flag to select incidents based on custom variables, for example, `!package=io.konveyor.demo.config-utils` -Usage: `{mta-cli} analyze [flags]` +a|`-i`, `–input` +|String +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]. -The following flags are available: +a|`--jaeger-endpoint` +|String +|Flag for the jaeger endpoint to collect traces. -.{ProductShortName} Analyze application -[cols="40%,60%a",options="header",] -|==== -|Flag |Description +a|`--json-output` +| +a|Flag to create analysis and dependency output as JSON. -| --analyze-known-libraries -| analyze known open source libraries +a|`--list-sources` +| +a|Flag to list rules for available migration sources. -| -h, --help -| help for analyze +a|`--list-targets` +| +|Flag to list rules for available migration targets. -| -i, --input string -| path to application source code or a binary +a|`--list-providers` +| +|Flag to list available supported providers. -| --json-output -| create analysis and dependency output as JSON +a|`-l`, `--label-selector` +|String +|Flag to run rules based on a specified label selector expression. -| --list-sources -| list rules for available migration sources +a|`--maven-settings` +|string +|Flag path to a custom Maven settings file to use -| --list-targets -| list rules for available migration targets +a|`--overwrite` +| +|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. -| -l, --label-selector string -| run rules based on specified label selector expression +a|`--skip-static-report` +| +|Flag to not generate static report. -| --maven-settings string -| path to a custom maven settings file to use +a|`-m`, `--mode` +|String +a|Flag for analysis mode, this must be one of `full`, for `source` and `dependencies`, or `source-only` (default `full`) -| --overwrite -| overwrite output directory +a|`-o`, `--output` +|String +|Flag for the path to the directory for analysis output. For more details, see xref:cli-output-argument_cli-guide[Specifying the output directory]. -| --skip-static-report -| do not generate static report +a|`--override-provider-settings` +|String +|Flag to override the provider settings, the analysis pod runs on the host network, and no providers are started up. -| -m, --mode string -| analysis mode" `full` (default) or `source-only` +a|`--provider` +|String Array +|Flag to specify which provider or providers to run. -| -o, --output string | path to the directory for analysis output +a|`--rules` +|String Array +a|Flag to specify the filename or directory containing rule files. Use multiple times for additional rules: `--rules --rules …` -| --rules stringArray | filename or directory containing rule files +a|`-s`, `--source` +|String Array +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]. -| --skip-static-report -| do not generate static report +a|`-t`, `--target` +|String Array +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]. +|==== -| -s, --source string -| source technology to consider for analysis. To specify multiple sources, repeat the parameter: --source --source etc. -| -t, --target string -| target technology to consider for analysis. To specify multiple targets, repeat the parameter: --target --target etc. -|==== +[id="cli-input-argument_{context}"] +== Specifying the input -[id="cli-input-file-type-arguments-global-flags_{context}"] -=== Global flags +A space-delimited list of the path to the file or directory containing one or more applications to be analyzed. This argument is required. -.{ProductShortName} Analyze application -[cols="40%,60%a",options="header",] -|==== +.Usage +[source,options="nowrap",subs="attributes+"] +---- +--input [...] +---- -|Flag -|Description +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. -| --log-level uint32 -| log level (default 4) +Directory:: ++ +[cols="1,1,1",options="header"] +|==== +| --explodedApp +| --sourceMode +| Neither Argument -| --no-cleanup -| do not clean up temporary resources +| The directory is evaluated as a single application. +| The directory is evaluated as a single application. +| Each subdirectory is evaluated as an application. |==== +File:: ++ +[cols="1,1,1",options="header"] +|==== +| --explodedApp +| --sourceMode +| Neither Argument +| Argument is ignored; the file is evaluated as a single application. +| The file is evaluated as a compressed project. +| The file is evaluated as a single application. +|==== [id="cli-output-argument_{context}"] == Specifying the output directory @@ -146,19 +172,20 @@ Specify the path to the directory to output the report information generated by --output ---- -* The `--output` argument is mandatory. If omitted, an error is returned: +* If omitted, the report will be generated in an `.report` directory. +* If the output directory exists, you will be prompted with the following (with a default of N). + [source,options="nowrap",subs="attributes+"] ---- -Error: required flag(s) "output" not set +Overwrite all contents of "/home/username/" (anything already in the directory will be deleted)? [y,N] ---- -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. +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. [id="cli-source-argument_{context}"] == Setting the source technology -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. +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. .Usage [source,options="nowrap",subs="attributes+"] @@ -166,11 +193,11 @@ A space-delimited list of one or more source technologies, servers, platforms, o --source ---- -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`. +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`. [WARNING] ==== -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. +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. See link:{ProductDocIntroToMTAGuideURL}/index#migration_paths_getting-started-guide[Supported migration paths] in _{IntroToMTABookName}_ for the appropriate JBoss EAP version. ==== @@ -178,7 +205,7 @@ See link:{ProductDocIntroToMTAGuideURL}/index#migration_paths_getting-started-gu [id="cli-target-argument_{context}"] == Setting the target technology -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. +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. .Usage [source,options="nowrap",subs="attributes+"] @@ -187,27 +214,4 @@ A space-delimited list of one or more target technologies, servers, platforms, o ---- -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`. - -[WARNING] -==== -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. - -See link:{ProductDocIntroToMTAGuideURL}/index#migration_paths_getting-started-guide[Supported migration paths] in _{IntroToMTABookName}_ for the appropriate JBoss EAP version. -==== - -//// -[id="cli-packages-argument_{context}"] -== Selecting packages - -A space-delimited list of the packages to be evaluated by {ProductShortName}. It is highly recommended to use this argument. - -.Usage -[source,options="nowrap",subs="attributes+"] ----- ----- - -* In most cases, you are interested only in evaluating custom application class packages and not standard Java EE or third party packages. The `` 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. -* 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. - -//// +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`. From e6d8cc80102337766ca209d30dd89d5d305fedf0 Mon Sep 17 00:00:00 2001 From: "A.Arnold" Date: Sun, 3 Nov 2024 19:23:44 +0000 Subject: [PATCH 02/25] Update Signed-off-by: A.Arnold --- docs/topics/mta-review-reports.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/topics/mta-review-reports.adoc b/docs/topics/mta-review-reports.adoc index 6bb2e17c..23134119 100644 --- a/docs/topics/mta-review-reports.adoc +++ b/docs/topics/mta-review-reports.adoc @@ -299,3 +299,4 @@ This report provides the list of rules that ran when running the {ProductShortNa .Rule providers execution overview image::3-13-rule-providers-execution-overview.png[Rule Provider Execution Overview] +//// From ad086c1c2375538ca271f24fd71a6eeb6e7eb570 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Sun, 3 Nov 2024 19:25:45 +0000 Subject: [PATCH 03/25] Update master.adoc --- docs/cli-guide/master.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/cli-guide/master.adoc b/docs/cli-guide/master.adoc index f023c617..06a7ef94 100644 --- a/docs/cli-guide/master.adoc +++ b/docs/cli-guide/master.adoc @@ -102,6 +102,8 @@ include::topics/mta-optimize-performance.adoc[leveloffset=+1] // Configure {ProductShortName} to Exclude Files and Packages // include::topics/mta-exclude-files-and-packages.adoc[leveloffset=+2] +[appendix] +== Reference material // {ProductShortName} Command-line Arguments include::topics/mta-cli-args.adoc[leveloffset=+2] From e180b1cbe53e31ad62ca0b43b7f14111b674cd46 Mon Sep 17 00:00:00 2001 From: "A.Arnold" Date: Mon, 4 Nov 2024 13:33:39 +0000 Subject: [PATCH 04/25] Update Signed-off-by: A.Arnold --- docs/cli-guide/master.adoc | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/docs/cli-guide/master.adoc b/docs/cli-guide/master.adoc index 06a7ef94..6763db41 100644 --- a/docs/cli-guide/master.adoc +++ b/docs/cli-guide/master.adoc @@ -108,4 +108,31 @@ include::topics/mta-optimize-performance.adoc[leveloffset=+1] // {ProductShortName} Command-line Arguments include::topics/mta-cli-args.adoc[leveloffset=+2] +/ Added in 4.3.0: list of supported Tech Tags +include::topics/tech-tags.adoc[leveloffset=+2] + +// Rule Story Points +include::topics/about-story-points.adoc[leveloffset=+2] + +For more information on categorizing tasks, see link:{ProductDocRulesGuideURL}/rule_categories_rules-development-guide#rule_categories_rules-development-guide[Using custom rule categories]. + +=== Additional Resources + +// Get Involved +include::topics/get-involved.adoc[leveloffset=+3] + +// Important Links +include::topics/important-links.adoc[leveloffset=+3] + +// Report Issues with {ProductShortName} + +==== Reporting issues + +{ProductShortName} uses Jira as its issue tracking system. If you encounter an issue executing {ProductShortName}, submit a link:{JiraWindupURL}[Jira issue]. + +// ********************************** +// * Appendix: Revision Information * +// ********************************** +include::topics/templates/revision-info.adoc[] + :!cli-guide: From 5d5450e0659b128a154eab95a6657246ec19fd94 Mon Sep 17 00:00:00 2001 From: "A.Arnold" Date: Mon, 4 Nov 2024 14:02:57 +0000 Subject: [PATCH 05/25] Update Signed-off-by: A.Arnold --- docs/cli-guide/master.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cli-guide/master.adoc b/docs/cli-guide/master.adoc index 6763db41..634ac872 100644 --- a/docs/cli-guide/master.adoc +++ b/docs/cli-guide/master.adoc @@ -108,7 +108,7 @@ include::topics/mta-optimize-performance.adoc[leveloffset=+1] // {ProductShortName} Command-line Arguments include::topics/mta-cli-args.adoc[leveloffset=+2] -/ Added in 4.3.0: list of supported Tech Tags +// Added in 4.3.0: list of supported Tech Tags include::topics/tech-tags.adoc[leveloffset=+2] // Rule Story Points From a3738b81a8965d25d7bc76cd9b1ef661b28f5be4 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Wed, 6 Nov 2024 23:46:19 +0000 Subject: [PATCH 06/25] Update docs/topics/mta-cli-args.adoc Co-authored-by: Mariya Pershina <53339200+mpershina@users.noreply.github.com> --- docs/topics/mta-cli-args.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index 23469604..e981fd12 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -94,7 +94,7 @@ a|`--skip-static-report` a|`-m`, `--mode` |String -a|Flag for analysis mode, this must be one of `full`, for `source` and `dependencies`, or `source-only` (default `full`) +a|Flag for analysis mode, this must be one of `full`, for `source` and `dependencies`, or `source-only` (default `full`). a|`-o`, `--output` |String From 3ced2db4ccd1971bc731096da0a7560153a59f6f Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Wed, 6 Nov 2024 23:46:31 +0000 Subject: [PATCH 07/25] Update docs/topics/mta-cli-args.adoc Co-authored-by: Mariya Pershina <53339200+mpershina@users.noreply.github.com> --- docs/topics/mta-cli-args.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index e981fd12..42e3fa0c 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -110,7 +110,7 @@ a|`--provider` a|`--rules` |String Array -a|Flag to specify the filename or directory containing rule files. Use multiple times for additional rules: `--rules --rules …` +a|Flag to specify the filename or directory containing rule files. Use multiple times for additional rules, for example, `--rules --rules …`. a|`-s`, `--source` |String Array From 29f737f4dc924f58139550da4df6a2721b3dd42a Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Wed, 6 Nov 2024 23:46:54 +0000 Subject: [PATCH 08/25] Update docs/topics/mta-cli-args.adoc Co-authored-by: Mariya Pershina <53339200+mpershina@users.noreply.github.com> --- docs/topics/mta-cli-args.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index 42e3fa0c..71ec50e9 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -102,7 +102,7 @@ a|`-o`, `--output` a|`--override-provider-settings` |String -|Flag to override the provider settings, the analysis pod runs on the host network, and no providers are started up. +|Flag to override the provider settings. The analysis pod runs on the host network, and no providers are started. a|`--provider` |String Array From 7bbfa0f60280aedbd343280211b13eac4dee20d0 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Wed, 6 Nov 2024 23:47:18 +0000 Subject: [PATCH 09/25] Update docs/topics/mta-cli-args.adoc Co-authored-by: Mariya Pershina <53339200+mpershina@users.noreply.github.com> --- docs/topics/mta-cli-args.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index 71ec50e9..d6bb38bb 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -118,7 +118,7 @@ a|Flag for the source technology to consider for analysis. Use multiple times fo a|`-t`, `--target` |String Array -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]. +a|Flag for the target technology to consider for analysis. Use multiple times for additional targets, for example, `--target --target …`. For more details, see xref:cli-target-argument_cli-guide[Setting the target technology]. |==== From 8d61cd0ca364710a6d082f8a72d60b0ce1bf4c30 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Wed, 6 Nov 2024 23:47:32 +0000 Subject: [PATCH 10/25] Update docs/topics/mta-cli-args.adoc Co-authored-by: Mariya Pershina <53339200+mpershina@users.noreply.github.com> --- docs/topics/mta-cli-args.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index d6bb38bb..9b3f29f1 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -114,7 +114,7 @@ a|Flag to specify the filename or directory containing rule files. Use multiple a|`-s`, `--source` |String Array -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]. +a|Flag for the source technology to consider for analysis. Use multiple times for additional sources, for example, `--source --source …`. For more details, see xref:cli-source-argument_cli-guide[Setting the source technology]. a|`-t`, `--target` |String Array From 9e66d1f70bc9082ebf016521a6b8bfe7510ba9c2 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Wed, 6 Nov 2024 23:47:50 +0000 Subject: [PATCH 11/25] Update docs/topics/mta-cli-args.adoc Co-authored-by: Mariya Pershina <53339200+mpershina@users.noreply.github.com> --- docs/topics/mta-cli-args.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index 9b3f29f1..3ac2c73e 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -156,7 +156,7 @@ File:: | --sourceMode | Neither Argument -| Argument is ignored; the file is evaluated as a single application. +| Argument is ignored. The file is evaluated as a single application. | The file is evaluated as a compressed project. | The file is evaluated as a single application. |==== From 114489e08db6c295df6d3220ff982db9dacbea0d Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Wed, 6 Nov 2024 23:48:11 +0000 Subject: [PATCH 12/25] Update docs/topics/mta-cli-args.adoc Co-authored-by: Mariya Pershina <53339200+mpershina@users.noreply.github.com> --- docs/topics/mta-cli-args.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index 3ac2c73e..a25d3c6e 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -173,7 +173,7 @@ Specify the path to the directory to output the report information generated by ---- * If omitted, the report will be generated in an `.report` directory. -* If the output directory exists, you will be prompted with the following (with a default of N). +* If the output directory exists, you will be prompted with the following question with a default answer of `N`: + [source,options="nowrap",subs="attributes+"] ---- From 8bd18f2ed37bc825a5d7c9c317fe37a48d84ca68 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Wed, 6 Nov 2024 23:48:22 +0000 Subject: [PATCH 13/25] Update docs/topics/mta-cli-args.adoc Co-authored-by: Mariya Pershina <53339200+mpershina@users.noreply.github.com> --- docs/topics/mta-cli-args.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index a25d3c6e..f4bc9646 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -185,7 +185,7 @@ However, if you specify the `--overwrite` argument, {ProductShortName} will proc [id="cli-source-argument_{context}"] == Setting the source technology -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. +A space-delimited list of one or more source technologies, servers, platforms, or frameworks to migrate from. You can use this argument, in conjunction with the `--target` argument, to determine which rulesets are used. Use the `--listSourceTechnologies` argument to list all available sources. .Usage [source,options="nowrap",subs="attributes+"] From 959ac753ddff02ed5e004642c531c38583b33eec Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Wed, 6 Nov 2024 23:48:42 +0000 Subject: [PATCH 14/25] Update docs/topics/mta-cli-args.adoc Co-authored-by: Mariya Pershina <53339200+mpershina@users.noreply.github.com> --- docs/topics/mta-cli-args.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index f4bc9646..4daace67 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -193,7 +193,7 @@ A space-delimited list of one or more source technologies, servers, platforms, o --source ---- -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`. +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`. [WARNING] ==== From dfa0ecf5a7427ff521f46b7175a965f4a4e2adee Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Wed, 6 Nov 2024 23:49:03 +0000 Subject: [PATCH 15/25] Update docs/topics/mta-cli-args.adoc Co-authored-by: Mariya Pershina <53339200+mpershina@users.noreply.github.com> --- docs/topics/mta-cli-args.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index 4daace67..d490256b 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -205,7 +205,7 @@ See link:{ProductDocIntroToMTAGuideURL}/index#migration_paths_getting-started-gu [id="cli-target-argument_{context}"] == Setting the target technology -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. +A space-delimited list of one or more target technologies, servers, platforms, or frameworks to migrate to. You can use this argument, in conjunction with the `--source` argument, 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. .Usage [source,options="nowrap",subs="attributes+"] From 8ac48198d41ca48d4497f09cc26b93eb5dcea53b Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Wed, 6 Nov 2024 23:49:21 +0000 Subject: [PATCH 16/25] Update docs/topics/mta-cli-args.adoc Co-authored-by: Mariya Pershina <53339200+mpershina@users.noreply.github.com> --- docs/topics/mta-cli-args.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index d490256b..d1a7b8d2 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -214,4 +214,4 @@ A space-delimited list of one or more target technologies, servers, platforms, o ---- -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`. +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`. From 550896bac936669d402a866e39c6f29751e6854c Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Mon, 11 Nov 2024 15:00:33 +0000 Subject: [PATCH 17/25] Update mta-cli-args.adoc --- docs/topics/mta-cli-args.adoc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index d1a7b8d2..bd6e55f9 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -19,6 +19,8 @@ To run the {ProductShortName} command without prompting, for example when execut ==== .{ProductShortName} CLI arguments +[%collapsible] +==== [cols="40%,60%a",options="header",] [width="100%",cols="30%,30%,65%",options="header",] |==== @@ -120,7 +122,7 @@ a|`-t`, `--target` |String Array a|Flag for the target technology to consider for analysis. Use multiple times for additional targets, for example, `--target --target …`. For more details, see xref:cli-target-argument_cli-guide[Setting the target technology]. |==== - +==== [id="cli-input-argument_{context}"] == Specifying the input From 23a8e38a5ba16c50d91ca74f0f5e804a10ee06c5 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Mon, 11 Nov 2024 15:25:35 +0000 Subject: [PATCH 18/25] Update docs/topics/mta-cli-args.adoc --- docs/topics/mta-cli-args.adoc | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index bd6e55f9..fded44e5 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -21,7 +21,6 @@ To run the {ProductShortName} command without prompting, for example when execut .{ProductShortName} CLI arguments [%collapsible] ==== -[cols="40%,60%a",options="header",] [width="100%",cols="30%,30%,65%",options="header",] |==== |Command |Type|Description From d3abf0b1cbf25a5685ffa7bf4080261faf8d177a Mon Sep 17 00:00:00 2001 From: "A.Arnold" Date: Thu, 14 Nov 2024 11:36:38 +0000 Subject: [PATCH 19/25] update Signed-off-by: A.Arnold --- docs/topics/mta-cli-args.adoc | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index fded44e5..27df71f5 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -85,14 +85,6 @@ a|`--maven-settings` |string |Flag path to a custom Maven settings file to use -a|`--overwrite` -| -|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. - -a|`--skip-static-report` -| -|Flag to not generate static report. - a|`-m`, `--mode` |String a|Flag for analysis mode, this must be one of `full`, for `source` and `dependencies`, or `source-only` (default `full`). @@ -105,6 +97,10 @@ a|`--override-provider-settings` |String |Flag to override the provider settings. The analysis pod runs on the host network, and no providers are started. +a|`--overwrite` +| +|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. + a|`--provider` |String Array |Flag to specify which provider or providers to run. @@ -113,6 +109,10 @@ a|`--rules` |String Array a|Flag to specify the filename or directory containing rule files. Use multiple times for additional rules, for example, `--rules --rules …`. +a|`--skip-static-report` +| +|Flag to not generate static report. + a|`-s`, `--source` |String Array a|Flag for the source technology to consider for analysis. Use multiple times for additional sources, for example, `--source --source …`. For more details, see xref:cli-source-argument_cli-guide[Setting the source technology]. From 2eebab5da1eb4c1e17501f19823fbb8cbe2b5574 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 14 Nov 2024 13:57:30 +0000 Subject: [PATCH 20/25] Update mta-cli-args.adoc --- docs/topics/mta-cli-args.adoc | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index 27df71f5..1f20691a 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -12,7 +12,6 @@ The following is a detailed description of the available {ProductShortName} comm ==== To run the {ProductShortName} command without prompting, for example when executing from a script, you must use the following arguments: -* `--batchMode` * `--overwrite` * `--input` * `--target` From 369bbf2e7128d50598bee6a52ea09b719a28d5ab Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 14 Nov 2024 14:03:19 +0000 Subject: [PATCH 21/25] Update mta-cli-args.adoc --- docs/topics/mta-cli-args.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index 1f20691a..783400e3 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -44,7 +44,7 @@ a|`--enable-default-rulesets` |Boolean a|Flag to run default rulesets with analysis (default: `true`). -a|`-h`, `–help` +a|`-h`, `--help` | |Flag to output help for analyze @@ -52,7 +52,7 @@ a|`--incident-selector` |String a|Flag to select incidents based on custom variables, for example, `!package=io.konveyor.demo.config-utils` -a|`-i`, `–input` +a|`-i`, `--input` |String 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]. From 235eeb638fad41964a0e2ac2eec452ff009965cf Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 14 Nov 2024 14:20:00 +0000 Subject: [PATCH 22/25] Update mta-cli-args.adoc --- docs/topics/mta-cli-args.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index 783400e3..756b1beb 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -36,7 +36,7 @@ a|Flag for running multiple analyze commands in bulk, which result in a combined |Integer |Flag to define the number of lines of source code to include in the output for each incident (default: `100`). -a|`-d`, `–dependency-folders` +a|`-d`, `--dependency-folders` |String Array |Flag for the directory for dependencies. From 805abf083f31cf6b0333f90f84c33f10b5625675 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 14 Nov 2024 14:29:03 +0000 Subject: [PATCH 23/25] Update mta-cli-args.adoc --- docs/topics/mta-cli-args.adoc | 21 ++------------------- 1 file changed, 2 insertions(+), 19 deletions(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index 756b1beb..ce1f1f51 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -137,29 +137,12 @@ Depending on whether the input file type provided to the `--input` argument is a Directory:: + -[cols="1,1,1",options="header"] -|==== -| --explodedApp -| --sourceMode -| Neither Argument - -| The directory is evaluated as a single application. -| The directory is evaluated as a single application. -| Each subdirectory is evaluated as an application. -|==== +* `--sourceMode`: The directory is evaluated as a single application. File:: + -[cols="1,1,1",options="header"] -|==== -| --explodedApp -| --sourceMode -| Neither Argument +* `--sourceMode`: The file is evaluated as a compressed project. -| Argument is ignored. The file is evaluated as a single application. -| The file is evaluated as a compressed project. -| The file is evaluated as a single application. -|==== [id="cli-output-argument_{context}"] == Specifying the output directory From 16191b776610c7713ab812f5ccc62cf678f7a641 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Mon, 18 Nov 2024 13:07:17 +0000 Subject: [PATCH 24/25] Update docs/topics/mta-cli-args.adoc --- docs/topics/mta-cli-args.adoc | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index ce1f1f51..69079b9c 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -48,6 +48,14 @@ a|`-h`, `--help` | |Flag to output help for analyze +a|`--http-proxy` +| String +| Flag for Hyper Text Transfer Protocol (HTTP) proxy string URL + +a|`--https-proxy` +| String +| Flag for Hypertext Transfer Protocol Secure (HTTPS) proxy string URL + a|`--incident-selector` |String a|Flag to select incidents based on custom variables, for example, `!package=io.konveyor.demo.config-utils` From 20f7cf9171bcd0549f22aabb31b407c639ff5b67 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Mon, 18 Nov 2024 13:23:18 +0000 Subject: [PATCH 25/25] Update mta-cli-args.adoc --- docs/topics/mta-cli-args.adoc | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index 69079b9c..0aa487b5 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -72,6 +72,14 @@ a|`--json-output` | a|Flag to create analysis and dependency output as JSON. +a|`-l`, `--label-selector` +|String +|Flag to run rules based on a specified label selector expression. + +a|`--list-providers` +| +|Flag to list available supported providers. + a|`--list-sources` | a|Flag to list rules for available migration sources. @@ -80,14 +88,6 @@ a|`--list-targets` | |Flag to list rules for available migration targets. -a|`--list-providers` -| -|Flag to list available supported providers. - -a|`-l`, `--label-selector` -|String -|Flag to run rules based on a specified label selector expression. - a|`--maven-settings` |string |Flag path to a custom Maven settings file to use @@ -96,6 +96,10 @@ a|`-m`, `--mode` |String a|Flag for analysis mode, this must be one of `full`, for `source` and `dependencies`, or `source-only` (default `full`). +a|`--no-proxy` +|String +|Flag to excluded URLs from passing through any proxy (relevant only with proxy) + a|`-o`, `--output` |String |Flag for the path to the directory for analysis output. For more details, see xref:cli-output-argument_cli-guide[Specifying the output directory]. @@ -116,6 +120,10 @@ a|`--rules` |String Array a|Flag to specify the filename or directory containing rule files. Use multiple times for additional rules, for example, `--rules --rules …`. +a|`--run-local` +| +|Local flag to run analysis directly on local system without containers (for Java and Maven) + a|`--skip-static-report` | |Flag to not generate static report.