From db4977d51ae17ec36ebd011845c373ecff650c79 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 18:34:48 +0000 Subject: [PATCH 01/26] MTA - Eli fix PR#837 Signed-off-by: Andy Arnold --- docs/topics/cli-run.adoc | 16 ++++++++++++++++ docs/topics/create-first-xml-rule.adoc | 4 ++-- docs/topics/using-openrewrite-recipes.adoc | 4 ++-- 3 files changed, 20 insertions(+), 4 deletions(-) diff --git a/docs/topics/cli-run.adoc b/docs/topics/cli-run.adoc index 17d4c78bca..a4083bfa9e 100644 --- a/docs/topics/cli-run.adoc +++ b/docs/topics/cli-run.adoc @@ -11,7 +11,9 @@ You can run {ProductShortName} against your application. .Procedure . Open a terminal and navigate to the `<{ProductShortName}_HOME>/bin/` directory. + . Execute the `{mta-cli}` script, or `{mta-cli}.exe` for Windows, and specify the appropriate arguments: + + [source,terminal,subs="attributes+"] ---- @@ -70,6 +72,20 @@ $ <{ProductShortName}_HOME>/bin/{mta-cli} --input /path/to/jee-example-app-1.0.0 [] [discrete] +<<<<<<< HEAD +======= +=== Overriding {ProductShortName} properties + +To override the default _Fernflower_ decompiler, pass the `-Dwindup.decompiler` argument on the command line. For example, to use the _Procyon_ decompiler, use the following syntax: + +[source,terminal,subs="attributes+"] +---- +$ <{ProductShortName}_HOME>/bin/{mta-cli} -Dwindup.decompiler=procyon \ + --input --output \ + --target --packages +---- + +>>>>>>> aec3e824 (insert mta-cli attribute instead of plain text windup-cli) [id="cli-bash-completion_{context}"] == {ProductShortName} {CLINameTitle} Bash completion diff --git a/docs/topics/create-first-xml-rule.adoc b/docs/topics/create-first-xml-rule.adoc index aed0c311e5..586688e592 100644 --- a/docs/topics/create-first-xml-rule.adoc +++ b/docs/topics/create-first-xml-rule.adoc @@ -213,8 +213,8 @@ Open a terminal and run the following command, passing the test file as an input [options="nowrap",subs="attributes+"] ---- -$ <{ProductShortName}_HOME>/bin/mta-cli --sourceMode --input /home//migration-rules/data --output /home//migration-rules/reports --target eap:6 ----- + +$ <{ProductShortName}_HOME>/mta-cli --sourceMode --input /home//migration-rules/data --output /home//migration-rules/reports --target eap:6 You should see the following result. diff --git a/docs/topics/using-openrewrite-recipes.adoc b/docs/topics/using-openrewrite-recipes.adoc index 0b019bafdb..7e15c2e6e6 100644 --- a/docs/topics/using-openrewrite-recipes.adoc +++ b/docs/topics/using-openrewrite-recipes.adoc @@ -22,7 +22,7 @@ For example, the OpenRewrite recipe `org.jboss.windup.JavaxToJakarta` renames im + [source,terminal,subs="attributes+"] ---- -$ ./{mta-cli} transform openrewrite --input \ +$ ./{mta-cli} --openrewrite --input \ "-Drewrite.configLocation=" \ "-DactiveRecipes=" --goal dryRun ---- @@ -53,7 +53,7 @@ You can include more than one recipe by specifying each in the `activeRecipes` p + [source,terminal,subs="attributes+"] ---- -$ ./{mta-cli} transform openrewrite --input \ +$ ./{mta-cli} --openrewrite --input \ "-Drewrite.configLocation=" \ "-DactiveRecipes=" --goal run ---- From 3ea5cb6b495a364dabcb4da84036a5cca3e3f01e Mon Sep 17 00:00:00 2001 From: Eli Marcus Date: Mon, 5 Feb 2024 18:33:32 +0200 Subject: [PATCH 02/26] Delete docs/topics/create-first-xml-rule.adoc seems to be causing a merge conflict --- docs/topics/create-first-xml-rule.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/topics/create-first-xml-rule.adoc b/docs/topics/create-first-xml-rule.adoc index 586688e592..aed0c311e5 100644 --- a/docs/topics/create-first-xml-rule.adoc +++ b/docs/topics/create-first-xml-rule.adoc @@ -213,8 +213,8 @@ Open a terminal and run the following command, passing the test file as an input [options="nowrap",subs="attributes+"] ---- - -$ <{ProductShortName}_HOME>/mta-cli --sourceMode --input /home//migration-rules/data --output /home//migration-rules/reports --target eap:6 +$ <{ProductShortName}_HOME>/bin/mta-cli --sourceMode --input /home//migration-rules/data --output /home//migration-rules/reports --target eap:6 +---- You should see the following result. From 7fb28e4c79271589160a93e792f11ef752c1117c Mon Sep 17 00:00:00 2001 From: emarcusRH Date: Tue, 6 Feb 2024 16:50:19 +0200 Subject: [PATCH 03/26] adding analyze to mta-cli analysis commands --- docs/topics/cli-run.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/topics/cli-run.adoc b/docs/topics/cli-run.adoc index a4083bfa9e..6babdc5d3f 100644 --- a/docs/topics/cli-run.adoc +++ b/docs/topics/cli-run.adoc @@ -40,7 +40,7 @@ The following command analyzes the `com.acme` and `org.apache` packages of the l [source,terminal,subs="attributes+"] ---- -$ <{ProductShortName}_HOME>/bin/{mta-cli} \ +$ <{ProductShortName}_HOME>/bin/{mta-cli} analyze \ --input /path/to/jee-example-app-1.0.0.ear \ --output /path/to/report-output/ --source eap:5 --target eap:7 \ --packages com.acme org.apache @@ -54,7 +54,7 @@ The following command analyzes the `org.jboss.seam` packages of the link:https:/ [source,terminal,subs="attributes+"] ---- -$ <{ProductShortName}_HOME>/bin/{mta-cli} --sourceMode --input /path/to/seam-booking-5.2/ \ +$ <{ProductShortName}_HOME>/bin/{mta-cli} analyze --sourceMode --input /path/to/seam-booking-5.2/ \ --output /path/to/report-output/ --target eap:6 --packages org.jboss.seam ---- [] @@ -65,7 +65,7 @@ The following command analyzes the `com.acme` and `org.apache` packages of the l [source,terminal,subs="attributes+"] ---- -$ <{ProductShortName}_HOME>/bin/{mta-cli} --input /path/to/jee-example-app-1.0.0.ear \ +$ <{ProductShortName}_HOME>/bin/{mta-cli} analyze --input /path/to/jee-example-app-1.0.0.ear \ --output /path/to/report-output/ \ --target eap:7 --target cloud-readiness --packages com.acme org.apache ---- From 6535f9aa43dd2eb7f6840328a1732dc00d7c8176 Mon Sep 17 00:00:00 2001 From: emarcusRH Date: Wed, 7 Feb 2024 17:33:03 +0200 Subject: [PATCH 04/26] updates to mta-cli analyze commands --- docs/topics/cli-run.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/topics/cli-run.adoc b/docs/topics/cli-run.adoc index 6babdc5d3f..6a31d657c7 100644 --- a/docs/topics/cli-run.adoc +++ b/docs/topics/cli-run.adoc @@ -17,7 +17,7 @@ You can run {ProductShortName} against your application. + [source,terminal,subs="attributes+"] ---- -$ ./{mta-cli} --input /path/to/jee-example-app-1.0.0.ear \ +$ ./{mta-cli} analyze --input /path/to/jee-example-app-1.0.0.ear \ --output /path/to/output --source weblogic --target eap:6 \ --packages com.acme org.apache ---- @@ -54,7 +54,7 @@ The following command analyzes the `org.jboss.seam` packages of the link:https:/ [source,terminal,subs="attributes+"] ---- -$ <{ProductShortName}_HOME>/bin/{mta-cli} analyze --sourceMode --input /path/to/seam-booking-5.2/ \ +$ <{ProductShortName}_HOME>/bin/{mta-cli} analyze --mode --input /path/to/seam-booking-5.2/ \ --output /path/to/report-output/ --target eap:6 --packages org.jboss.seam ---- [] From 4d906b3b8fbf28d7496ededf7995f0ff118fa9e1 Mon Sep 17 00:00:00 2001 From: emarcusRH Date: Thu, 8 Feb 2024 19:27:53 +0200 Subject: [PATCH 05/26] updates to mta-cli analyze commands --- docs/topics/cli-run.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/cli-run.adoc b/docs/topics/cli-run.adoc index 6a31d657c7..b4b614e9d9 100644 --- a/docs/topics/cli-run.adoc +++ b/docs/topics/cli-run.adoc @@ -54,7 +54,7 @@ The following command analyzes the `org.jboss.seam` packages of the link:https:/ [source,terminal,subs="attributes+"] ---- -$ <{ProductShortName}_HOME>/bin/{mta-cli} analyze --mode --input /path/to/seam-booking-5.2/ \ +$ <{ProductShortName}_HOME>/bin/{mta-cli} analyze --mode source-only --input /path/to/seam-booking-5.2/ \ --output /path/to/report-output/ --target eap:6 --packages org.jboss.seam ---- [] From 5de1baf7eeb978a5dd52db89669fc5e53e1d87a2 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 19:07:23 +0000 Subject: [PATCH 06/26] Update docs/topics/cli-run.adoc --- docs/topics/cli-run.adoc | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/topics/cli-run.adoc b/docs/topics/cli-run.adoc index b4b614e9d9..a992fa8a31 100644 --- a/docs/topics/cli-run.adoc +++ b/docs/topics/cli-run.adoc @@ -72,7 +72,6 @@ $ <{ProductShortName}_HOME>/bin/{mta-cli} analyze --input /path/to/jee-example-a [] [discrete] -<<<<<<< HEAD ======= === Overriding {ProductShortName} properties From 05dbded84815ff6e7714559d6279a0c0dbcef2d4 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 19:08:46 +0000 Subject: [PATCH 07/26] Update docs/topics/cli-run.adoc --- docs/topics/cli-run.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/cli-run.adoc b/docs/topics/cli-run.adoc index a992fa8a31..cdeaeea18f 100644 --- a/docs/topics/cli-run.adoc +++ b/docs/topics/cli-run.adoc @@ -71,7 +71,7 @@ $ <{ProductShortName}_HOME>/bin/{mta-cli} analyze --input /path/to/jee-example-a ---- [] -[discrete] +//// [discrete] ======= === Overriding {ProductShortName} properties From a4bf30445d09327f313f9d31e7e4dbc7102aadd6 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 19:09:39 +0000 Subject: [PATCH 08/26] Update docs/topics/cli-run.adoc --- docs/topics/cli-run.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/cli-run.adoc b/docs/topics/cli-run.adoc index cdeaeea18f..7ad272cbef 100644 --- a/docs/topics/cli-run.adoc +++ b/docs/topics/cli-run.adoc @@ -83,7 +83,7 @@ $ <{ProductShortName}_HOME>/bin/{mta-cli} -Dwindup.decompiler=procyon \ --input --output \ --target --packages ---- - +//// >>>>>>> aec3e824 (insert mta-cli attribute instead of plain text windup-cli) [id="cli-bash-completion_{context}"] == {ProductShortName} {CLINameTitle} Bash completion From d987cb483490600f71c5c86bd2050cef1bc9c1ab Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 19:10:04 +0000 Subject: [PATCH 09/26] Update docs/topics/cli-run.adoc --- docs/topics/cli-run.adoc | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/topics/cli-run.adoc b/docs/topics/cli-run.adoc index 7ad272cbef..f18881e51a 100644 --- a/docs/topics/cli-run.adoc +++ b/docs/topics/cli-run.adoc @@ -84,7 +84,6 @@ $ <{ProductShortName}_HOME>/bin/{mta-cli} -Dwindup.decompiler=procyon \ --target --packages ---- //// ->>>>>>> aec3e824 (insert mta-cli attribute instead of plain text windup-cli) [id="cli-bash-completion_{context}"] == {ProductShortName} {CLINameTitle} Bash completion From f4b2a2d1f6215bb8e0ea59ecbe239b01571f4052 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 19:10:44 +0000 Subject: [PATCH 10/26] Update docs/topics/using-openrewrite-recipes.adoc --- docs/topics/using-openrewrite-recipes.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/using-openrewrite-recipes.adoc b/docs/topics/using-openrewrite-recipes.adoc index 7e15c2e6e6..acac0af961 100644 --- a/docs/topics/using-openrewrite-recipes.adoc +++ b/docs/topics/using-openrewrite-recipes.adoc @@ -22,7 +22,7 @@ For example, the OpenRewrite recipe `org.jboss.windup.JavaxToJakarta` renames im + [source,terminal,subs="attributes+"] ---- -$ ./{mta-cli} --openrewrite --input \ +$ ./{mta-cli} transform openrewrite --input \ "-Drewrite.configLocation=" \ "-DactiveRecipes=" --goal dryRun ---- From 2f91734ef6bb7f744234741b77a4afd49022c9cc Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 19:12:04 +0000 Subject: [PATCH 11/26] Update docs/topics/cli-run.adoc --- docs/topics/cli-run.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/topics/cli-run.adoc b/docs/topics/cli-run.adoc index f18881e51a..36bebd7540 100644 --- a/docs/topics/cli-run.adoc +++ b/docs/topics/cli-run.adoc @@ -71,7 +71,8 @@ $ <{ProductShortName}_HOME>/bin/{mta-cli} analyze --input /path/to/jee-example-a ---- [] -//// [discrete] +//// +[discrete] ======= === Overriding {ProductShortName} properties From ec4ee18e1490df04597201953495d5ea42b5d788 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 20:09:30 +0000 Subject: [PATCH 12/26] Update docs/topics/cli-run.adoc --- docs/topics/cli-run.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/cli-run.adoc b/docs/topics/cli-run.adoc index 36bebd7540..9fbd21b5bb 100644 --- a/docs/topics/cli-run.adoc +++ b/docs/topics/cli-run.adoc @@ -10,7 +10,7 @@ You can run {ProductShortName} against your application. .Procedure -. Open a terminal and navigate to the `<{ProductShortName}_HOME>/bin/` directory. +. Open a terminal and navigate to the `<{ProductShortName}_HOME>/` directory. . Execute the `{mta-cli}` script, or `{mta-cli}.exe` for Windows, and specify the appropriate arguments: From 64a896bb75f943044844b204f9d85d8419a1c64c Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 20:10:50 +0000 Subject: [PATCH 13/26] Update docs/topics/cli-run.adoc --- docs/topics/cli-run.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/cli-run.adoc b/docs/topics/cli-run.adoc index 9fbd21b5bb..d86905eda7 100644 --- a/docs/topics/cli-run.adoc +++ b/docs/topics/cli-run.adoc @@ -40,7 +40,7 @@ The following command analyzes the `com.acme` and `org.apache` packages of the l [source,terminal,subs="attributes+"] ---- -$ <{ProductShortName}_HOME>/bin/{mta-cli} analyze \ +$ <{ProductShortName}_HOME>/{mta-cli} analyze \ --input /path/to/jee-example-app-1.0.0.ear \ --output /path/to/report-output/ --source eap:5 --target eap:7 \ --packages com.acme org.apache From 3e92390b2ce90d6cf88249c0399cc1f26a71c2db Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 20:11:37 +0000 Subject: [PATCH 14/26] Update cli-run.adoc --- docs/topics/cli-run.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/cli-run.adoc b/docs/topics/cli-run.adoc index d86905eda7..e001c11864 100644 --- a/docs/topics/cli-run.adoc +++ b/docs/topics/cli-run.adoc @@ -19,7 +19,7 @@ You can run {ProductShortName} against your application. ---- $ ./{mta-cli} analyze --input /path/to/jee-example-app-1.0.0.ear \ --output /path/to/output --source weblogic --target eap:6 \ - --packages com.acme org.apache + ---- + * `--input`: The application to be evaluated. From 48bec4f7d1012d02d929bf6cd2e5f5833791f54b Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Fri, 9 Feb 2024 21:24:13 +0000 Subject: [PATCH 15/26] Fixing cli-run.adoc for windup Signed-off-by: Andy Arnold --- docs/cli-guide-mtr/master.adoc | 2 +- docs/cli-guide/master.adoc | 2 +- .../topics/{cli-run.adoc => mta-cli-run.adoc} | 26 ++-- docs/topics/mtr-cli-run.adoc | 133 ++++++++++++++++++ 4 files changed, 146 insertions(+), 17 deletions(-) rename docs/topics/{cli-run.adoc => mta-cli-run.adoc} (85%) create mode 100644 docs/topics/mtr-cli-run.adoc diff --git a/docs/cli-guide-mtr/master.adoc b/docs/cli-guide-mtr/master.adoc index 6cf8f8f759..1d8d878e9f 100644 --- a/docs/cli-guide-mtr/master.adoc +++ b/docs/cli-guide-mtr/master.adoc @@ -31,7 +31,7 @@ include::topics/about-cli.adoc[leveloffset=+2] include::topics/installing-web-console-or-cli-tool.adoc[leveloffset=+2] // Run the CLI -include::topics/cli-run.adoc[leveloffset=+2] +include::topics/mtr-cli-run.adoc[leveloffset=+2] // Use OpenRewrite recipes include::topics/using-openrewrite-recipes.adoc[leveloffset=+3] diff --git a/docs/cli-guide/master.adoc b/docs/cli-guide/master.adoc index 503288d9ec..a7bdc931a5 100644 --- a/docs/cli-guide/master.adoc +++ b/docs/cli-guide/master.adoc @@ -35,7 +35,7 @@ include::topics/about-cli.adoc[leveloffset=+2] include::topics/installing-cli-tool.adoc[leveloffset=+2] // Run the CLI -include::topics/cli-run.adoc[leveloffset=+2] +include::topics/mta-cli-run.adoc[leveloffset=+2] // Analyze application source code include::topics/mta-cli-analyze.adoc[leveloffset=+3] diff --git a/docs/topics/cli-run.adoc b/docs/topics/mta-cli-run.adoc similarity index 85% rename from docs/topics/cli-run.adoc rename to docs/topics/mta-cli-run.adoc index e001c11864..ce8b692a08 100644 --- a/docs/topics/cli-run.adoc +++ b/docs/topics/mta-cli-run.adoc @@ -18,15 +18,12 @@ You can run {ProductShortName} against your application. [source,terminal,subs="attributes+"] ---- $ ./{mta-cli} analyze --input /path/to/jee-example-app-1.0.0.ear \ - --output /path/to/output --source weblogic --target eap:6 \ - + --output /path/to/output --source weblogic --target eap6 \ ---- + * `--input`: The application to be evaluated. * `--output`: The output directory for the generated reports. * `--source`: The source technology for the application migration. -* `--target`: The target technology for the application migration. -* `--packages`: The packages to be evaluated. This argument is highly recommended to improve performance. . Access the report. @@ -42,8 +39,7 @@ The following command analyzes the `com.acme` and `org.apache` packages of the l ---- $ <{ProductShortName}_HOME>/{mta-cli} analyze \ --input /path/to/jee-example-app-1.0.0.ear \ - --output /path/to/report-output/ --source eap:5 --target eap:7 \ - --packages com.acme org.apache + --output /path/to/report-output/ --source eap5 --target eap7 \ ---- [] @@ -54,8 +50,9 @@ The following command analyzes the `org.jboss.seam` packages of the link:https:/ [source,terminal,subs="attributes+"] ---- + $ <{ProductShortName}_HOME>/bin/{mta-cli} analyze --mode source-only --input /path/to/seam-booking-5.2/ \ - --output /path/to/report-output/ --target eap:6 --packages org.jboss.seam + --output /path/to/report-output/ --target eap6 --packages org.jboss.seam ---- [] [discrete] @@ -67,24 +64,22 @@ The following command analyzes the `com.acme` and `org.apache` packages of the l ---- $ <{ProductShortName}_HOME>/bin/{mta-cli} analyze --input /path/to/jee-example-app-1.0.0.ear \ --output /path/to/report-output/ \ - --target eap:7 --target cloud-readiness --packages com.acme org.apache + --target eap7 ---- [] - -//// +//// [discrete] -======= === Overriding {ProductShortName} properties To override the default _Fernflower_ decompiler, pass the `-Dwindup.decompiler` argument on the command line. For example, to use the _Procyon_ decompiler, use the following syntax: [source,terminal,subs="attributes+"] ---- -$ <{ProductShortName}_HOME>/bin/{mta-cli} -Dwindup.decompiler=procyon \ +$ <{ProductShortName}_HOME>/{mta-cli} -Dwindup.decompiler=procyon \ --input --output \ - --target --packages ---- //// +//// [id="cli-bash-completion_{context}"] == {ProductShortName} {CLINameTitle} Bash completion @@ -92,7 +87,7 @@ The {ProductShortName} {CLIName} provides an option to enable Bash completion fo [source,terminal,subs="attributes+"] ---- -$ <{ProductShortName}_HOME>/bin/{mta-cli} [TAB] +$ <{ProductShortName}_HOME>/{mta-cli} [TAB] ---- [discrete] @@ -133,5 +128,6 @@ To see the complete list of available arguments for the `{mta-cli}` command, ope [source,terminal,subs="attributes+"] ---- -$ <{ProductShortName}_HOME>/bin/{mta-cli} --help +$ <{ProductShortName}_HOME>/{mta-cli} --help ---- +//// diff --git a/docs/topics/mtr-cli-run.adoc b/docs/topics/mtr-cli-run.adoc new file mode 100644 index 0000000000..058ddf2b3f --- /dev/null +++ b/docs/topics/mtr-cli-run.adoc @@ -0,0 +1,133 @@ +// Module included in the following assemblies: +// +// * docs/cli-guide/master.adoc + +:_content-type: PROCEDURE +[id="cli-run_{context}"] += Running the {CLINameTitle} + +You can run {ProductShortName} against your application. + +.Procedure + +. Open a terminal and navigate to the `<{ProductShortName}_HOME>/bin/` directory. +. Execute the `windup-cli` script, or `windup-cli.bat` for Windows, and specify the appropriate arguments: ++ +[source,terminal,subs="attributes+"] +---- +$ ./windup-cli --input /path/to/jee-example-app-1.0.0.ear \ + --output /path/to/output --source weblogic --target eap:6 \ + --packages com.acme org.apache +---- ++ +* `--input`: The application to be evaluated. +* `--output`: The output directory for the generated reports. +* `--source`: The source technology for the application migration. +* `--target`: The target technology for the application migration. +* `--packages`: The packages to be evaluated. This argument is highly recommended to improve performance. + +. Access the report. + +[id="command-examples_{context}"] +== {ProductShortName} command examples + +[discrete] +=== Running {ProductShortName} on an application archive + +The following command analyzes the `com.acme` and `org.apache` packages of the link:https://github.com/windup/windup/blob/master/test-files/jee-example-app-1.0.0.ear[jee-example-app-1.0.0.ear] example EAR archive for migrating from JBoss EAP 5 to JBoss EAP 7: + +[source,terminal,subs="attributes+"] +---- +$ <{ProductShortName}_HOME>/bin/windup-cli \ + --input /path/to/jee-example-app-1.0.0.ear \ + --output /path/to/report-output/ --source eap:5 --target eap:7 \ + --packages com.acme org.apache +---- +[] + +[discrete] +=== Running {ProductShortName} on source code + +The following command analyzes the `org.jboss.seam` packages of the link:https://github.com/windup/windup/tree/master/test-files/seam-booking-5.2[seam-booking-5.2] example source code for migrating to JBoss EAP 6. + +[source,terminal,subs="attributes+"] +---- +$ <{ProductShortName}_HOME>/bin/windup-cli --sourceMode --input /path/to/seam-booking-5.2/ \ + --output /path/to/report-output/ --target eap:6 --packages org.jboss.seam +---- +[] +[discrete] +=== Running cloud-readiness rules + +The following command analyzes the `com.acme` and `org.apache` packages of the link:https://github.com/windup/windup/blob/master/test-files/jee-example-app-1.0.0.ear[jee-example-app-1.0.0.ear] example EAR archive for migrating to JBoss EAP 7. It also evaluates for cloud readiness: + +[source,terminal,subs="attributes+"] +---- +$ <{ProductShortName}_HOME>/bin/windup-cli --input /path/to/jee-example-app-1.0.0.ear \ + --output /path/to/report-output/ \ + --target eap:7 --target cloud-readiness --packages com.acme org.apache +---- +[] + +[discrete] +=== Overriding {ProductShortName} properties + +To override the default _Fernflower_ decompiler, pass the `-Dwindup.decompiler` argument on the command line. For example, to use the _Procyon_ decompiler, use the following syntax: + +[source,terminal,subs="attributes+"] +---- +$ <{ProductShortName}_HOME>/bin/windup-cli -Dwindup.decompiler=procyon \ + --input --output \ + --target --packages +---- + +[id="cli-bash-completion_{context}"] +== {ProductShortName} {CLINameTitle} Bash completion + +The {ProductShortName} {CLIName} provides an option to enable Bash completion for Linux systems, allowing the {ProductShortName} command-line arguments to be auto completed by pressing the Tab key when entering the commands. For instance, when Bash completion is enabled, entering the following displays a list of available arguments. + +[source,terminal,subs="attributes+"] +---- +$ <{ProductShortName}_HOME>/bin/windup-cli [TAB] +---- + +[discrete] +[id="bash-completion-temporary_{context}"] +=== Enabling Bash completion + +To enable Bash completion for the current shell, execute the following command: + +[source,terminal,subs="attributes+"] +---- +$ source <{ProductShortName}_HOME>/bash-completion/windup-cli +---- + +[discrete] +[id="bash-completion-persistent_{context}"] +=== Enabling persistent Bash completion + +The following commands allow Bash completion to persist across restarts: + +* To enable Bash completion for a specific user across system restarts, include the following line in that user's `~/.bashrc` file. ++ +[source,terminal,subs="attributes+"] +---- +source <{ProductShortName}_HOME>/bash-completion/windup-cli +---- + +* To enable Bash completion for all users across system restarts, copy the {ProductName} {CLIName} Bash completion file to the `/etc/bash_completion.d/` directory as the root user. ++ +[source,terminal,subs="attributes+"] +---- +# cp <{ProductShortName}_HOME>/bash-completion/windup-cli /etc/bash_completion.d/ +---- + +[id="accessing-help_{context}"] +== Accessing {ProductShortName} help + +To see the complete list of available arguments for the `windup-cli` command, open a terminal, navigate to the `<{ProductShortName}_HOME>` directory, and execute the following command: + +[source,terminal,subs="attributes+"] +---- +$ <{ProductShortName}_HOME>/bin/windup-cli --help +---- From 006655a0ae56d2761c5b5c1706a558a0d95cab63 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Fri, 9 Feb 2024 22:34:40 +0000 Subject: [PATCH 16/26] Fixing using-openrewrite-recipes.adoc Signed-off-by: Andy Arnold --- docs/cli-guide-mtr/master.adoc | 2 +- docs/cli-guide/master.adoc | 2 +- .../topics/mta-using-openrewrite-recipes.adoc | 59 +++++++++++++++++++ .../topics/mtr-using-openrewrite-recipes.adoc | 59 +++++++++++++++++++ 4 files changed, 120 insertions(+), 2 deletions(-) create mode 100644 docs/topics/mta-using-openrewrite-recipes.adoc create mode 100644 docs/topics/mtr-using-openrewrite-recipes.adoc diff --git a/docs/cli-guide-mtr/master.adoc b/docs/cli-guide-mtr/master.adoc index 1d8d878e9f..976623ad79 100644 --- a/docs/cli-guide-mtr/master.adoc +++ b/docs/cli-guide-mtr/master.adoc @@ -34,7 +34,7 @@ include::topics/installing-web-console-or-cli-tool.adoc[leveloffset=+2] include::topics/mtr-cli-run.adoc[leveloffset=+2] // Use OpenRewrite recipes -include::topics/using-openrewrite-recipes.adoc[leveloffset=+3] +include::topics/mtr-using-openrewrite-recipes.adoc[leveloffset=+3] // Available OpenRewrite recipes include::topics/available-openrewrite-recipes.adoc[leveloffset=+4] diff --git a/docs/cli-guide/master.adoc b/docs/cli-guide/master.adoc index a7bdc931a5..26218dc69b 100644 --- a/docs/cli-guide/master.adoc +++ b/docs/cli-guide/master.adoc @@ -44,7 +44,7 @@ include::topics/mta-cli-analyze.adoc[leveloffset=+3] include::topics/mta-cli-transform.adoc[leveloffset=+3] // Use OpenRewrite recipes -include::topics/using-openrewrite-recipes.adoc[leveloffset=+3] +include::topics/mta-using-openrewrite-recipes.adoc[leveloffset=+3] // Available OpenRewrite recipes include::topics/available-openrewrite-recipes.adoc[leveloffset=+4] diff --git a/docs/topics/mta-using-openrewrite-recipes.adoc b/docs/topics/mta-using-openrewrite-recipes.adoc new file mode 100644 index 0000000000..0b019bafdb --- /dev/null +++ b/docs/topics/mta-using-openrewrite-recipes.adoc @@ -0,0 +1,59 @@ +// Module included in the following module: +// +// * docs/cli-guide-mtr/master.adoc + +[id=using-openrewrite-recipes_{context}] += Using OpenRewrite recipes + +[IMPORTANT] +==== +OpenRewrite recipe support is provided as Technology Preview only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs), might not be functionally complete, and Red Hat does not recommend to use them for production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. + +See link:{KBArticleTechnologyPreview}[Technology Preview features support scope] on the Red Hat Customer Portal for information about the support scope for Technology Preview features. +==== + +You can refactor the source code of Java applications by using link:https://docs.openrewrite.org/[OpenRewrite] recipes with the {ProductShortName} CLI. + +For example, the OpenRewrite recipe `org.jboss.windup.JavaxToJakarta` renames imported `javax` packages to their `jakarta` equivalents. + +.Procedure + +. Run `{mta-cli}`, specifying the recipe name, the path to the configuration file, and the application: ++ +[source,terminal,subs="attributes+"] +---- +$ ./{mta-cli} transform openrewrite --input \ + "-Drewrite.configLocation=" \ + "-DactiveRecipes=" --goal dryRun +---- + +* `"-DactiveRecipes="`: Specify the OpenRewrite recipe, for example, `org.jboss.windup.JavaxToJakarta`. + +* `--input`: Specify the application to be refactored. The application must be the top of the source code project containing a Maven Project Object Model (POM) XML file, `pom.xml`. + +* `-Drewrite.configLocation=` : The location of the `rewrite.yaml` configuration file to use. + The shipped `rewrite.yaml` configuration files are located in your +`<{ProductShortName}_HOME>/rules/openrewrite` subfolder, for example,`" -Drewrite.configLocation=<{ProductShortName}_HOME>/rules/openrewrite/jakarta/javax/imports/rewrite.yaml"`. + +* `"-DactiveRecipes="`: Specify the OpenRewrite recipe, for example, `org.jboss.windup.JavaxToJakarta`. ++ +You can include more than one recipe by specifying each in the `activeRecipes` parameter. For example, to include the recipes `org.jboss.windup.JavaxInjectToJakartaInject` and `org.jboss.windup.JavaxEjbToJakartaEjb"`, enter the following for `"-DactiveRecipes="`: ++ +[source, terminal,subs="attributes+"] +---- + "-DactiveRecipes=org.jboss.windup.JavaxInjectToJakartaInject, \ + org.jboss.windup.JavaxEjbToJakartaEjb" +---- + +* `--goal`: Optional: The OpenRewrite Maven goal to run. +** `dryRun` : The script returns a list of proposed changes. Ignore the `"Run 'mvn rewrite:run' to apply the recipes"` message. +** `run`: The script applies the changes. + +. Run `{mta-cli}` with `--goal run` to apply the recipe: ++ +[source,terminal,subs="attributes+"] +---- +$ ./{mta-cli} transform openrewrite --input \ + "-Drewrite.configLocation=" \ + "-DactiveRecipes=" --goal run +---- diff --git a/docs/topics/mtr-using-openrewrite-recipes.adoc b/docs/topics/mtr-using-openrewrite-recipes.adoc new file mode 100644 index 0000000000..edede93f41 --- /dev/null +++ b/docs/topics/mtr-using-openrewrite-recipes.adoc @@ -0,0 +1,59 @@ +// Module included in the following module: +// +// * docs/cli-guide-mtr/master.adoc + +[id=using-openrewrite-recipes_{context}] += Using OpenRewrite recipes + +[IMPORTANT] +==== +OpenRewrite recipe support is provided as Technology Preview only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs), might not be functionally complete, and Red Hat does not recommend to use them for production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. + +See link:{KBArticleTechnologyPreview}[Technology Preview features support scope] on the Red Hat Customer Portal for information about the support scope for Technology Preview features. +==== + +You can refactor the source code of Java applications by using link:https://docs.openrewrite.org/[OpenRewrite] recipes with the {ProductShortName} CLI. + +For example, the OpenRewrite recipe `org.jboss.windup.JavaxToJakarta` renames imported `javax` packages to their `jakarta` equivalents. + +.Procedure + +. Run `windup-cli`, specifying the recipe name, the path to the configuration file, and the application: ++ +[source,terminal,subs="attributes+"] +---- +$ ./windup-cli --openrewrite --input \ + "-Drewrite.configLocation=" \ + "-DactiveRecipes=" --goal dryRun +---- + +* `"-DactiveRecipes="`: Specify the OpenRewrite recipe, for example, `org.jboss.windup.JavaxToJakarta`. + +* `--input`: Specify the application to be refactored. The application must be the top of the source code project containing a Maven Project Object Model (POM) XML file, `pom.xml`. + +* `-Drewrite.configLocation=` : The location of the `rewrite.yaml` configuration file to use. + The shipped `rewrite.yaml` configuration files are located in your +`<{ProductShortName}_HOME>/rules/openrewrite` subfolder, for example,`" -Drewrite.configLocation=<{ProductShortName}_HOME>/rules/openrewrite/jakarta/javax/imports/rewrite.yaml"`. + +* `"-DactiveRecipes="`: Specify the OpenRewrite recipe, for example, `org.jboss.windup.JavaxToJakarta`. ++ +You can include more than one recipe by specifying each in the `activeRecipes` parameter. For example, to include the recipes `org.jboss.windup.JavaxInjectToJakartaInject` and `org.jboss.windup.JavaxEjbToJakartaEjb"`, enter the following for `"-DactiveRecipes="`: ++ +[source, terminal,subs="attributes+"] +---- + "-DactiveRecipes=org.jboss.windup.JavaxInjectToJakartaInject, \ + org.jboss.windup.JavaxEjbToJakartaEjb" +---- + +* `--goal`: Optional: The OpenRewrite Maven goal to run. +** `dryRun` : The script returns a list of proposed changes. Ignore the `"Run 'mvn rewrite:run' to apply the recipes"` message. +** `run`: The script applies the changes. + +. Run `windup-cli` with `--goal run` to apply the recipe: ++ +[source,terminal,subs="attributes+"] +---- +$ ./windup-cli --openrewrite --input \ + "-Drewrite.configLocation=" \ + "-DactiveRecipes=" --goal run +---- From 484c551178027248fd9a65556829d7950f60e39b Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Fri, 9 Feb 2024 22:40:03 +0000 Subject: [PATCH 17/26] Update Signed-off-by: Andy Arnold --- website/docs/cli-guide/master.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cli-guide/master.adoc b/website/docs/cli-guide/master.adoc index f3d6f6ab4f..728ded0ac0 100644 --- a/website/docs/cli-guide/master.adoc +++ b/website/docs/cli-guide/master.adoc @@ -29,7 +29,7 @@ include::topics/about-cli.adoc[leveloffset=+2] include::topics/installing-web-console-or-cli-tool.adoc[leveloffset=+2] // Run the CLI -include::topics/cli-run.adoc[leveloffset=+2] +include::topics/mtr-cli-run.adoc[leveloffset=+2] // Access the Report include::topics/access-report.adoc[leveloffset=+2] From 129feca315cf6bcd11a4f7e0d0e4cf2f09fc9486 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Fri, 9 Feb 2024 22:44:14 +0000 Subject: [PATCH 18/26] Update Signed-off-by: Andy Arnold --- docs/cli-guide-mtr/master.adoc | 2 +- docs/topics/{mtr-cli-run.adoc => cli-run.adoc} | 0 website/docs/cli-guide/master.adoc | 2 +- 3 files changed, 2 insertions(+), 2 deletions(-) rename docs/topics/{mtr-cli-run.adoc => cli-run.adoc} (100%) diff --git a/docs/cli-guide-mtr/master.adoc b/docs/cli-guide-mtr/master.adoc index 976623ad79..6e2eb8da7a 100644 --- a/docs/cli-guide-mtr/master.adoc +++ b/docs/cli-guide-mtr/master.adoc @@ -31,7 +31,7 @@ include::topics/about-cli.adoc[leveloffset=+2] include::topics/installing-web-console-or-cli-tool.adoc[leveloffset=+2] // Run the CLI -include::topics/mtr-cli-run.adoc[leveloffset=+2] +include::topics/cli-run.adoc[leveloffset=+2] // Use OpenRewrite recipes include::topics/mtr-using-openrewrite-recipes.adoc[leveloffset=+3] diff --git a/docs/topics/mtr-cli-run.adoc b/docs/topics/cli-run.adoc similarity index 100% rename from docs/topics/mtr-cli-run.adoc rename to docs/topics/cli-run.adoc diff --git a/website/docs/cli-guide/master.adoc b/website/docs/cli-guide/master.adoc index 728ded0ac0..f3d6f6ab4f 100644 --- a/website/docs/cli-guide/master.adoc +++ b/website/docs/cli-guide/master.adoc @@ -29,7 +29,7 @@ include::topics/about-cli.adoc[leveloffset=+2] include::topics/installing-web-console-or-cli-tool.adoc[leveloffset=+2] // Run the CLI -include::topics/mtr-cli-run.adoc[leveloffset=+2] +include::topics/cli-run.adoc[leveloffset=+2] // Access the Report include::topics/access-report.adoc[leveloffset=+2] From 43761fc5a5effdeb8547d34a41331ab354164a3f Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Sun, 11 Feb 2024 02:15:28 +0000 Subject: [PATCH 19/26] Update docs/topics/mta-cli-run.adoc --- docs/topics/mta-cli-run.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/mta-cli-run.adoc b/docs/topics/mta-cli-run.adoc index ce8b692a08..cb7438941f 100644 --- a/docs/topics/mta-cli-run.adoc +++ b/docs/topics/mta-cli-run.adoc @@ -62,7 +62,7 @@ The following command analyzes the `com.acme` and `org.apache` packages of the l [source,terminal,subs="attributes+"] ---- -$ <{ProductShortName}_HOME>/bin/{mta-cli} analyze --input /path/to/jee-example-app-1.0.0.ear \ +$ <{ProductShortName}_HOME>/{mta-cli} analyze --input /path/to/jee-example-app-1.0.0.ear \ --output /path/to/report-output/ \ --target eap7 ---- From 43ae2dd925537949235e1a886c96b360d1aaf6b6 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Sun, 11 Feb 2024 12:30:52 +0000 Subject: [PATCH 20/26] Update Signed-off-by: Andy Arnold --- docs/topics/using-openrewrite-recipes.adoc | 59 ---------------------- 1 file changed, 59 deletions(-) delete mode 100644 docs/topics/using-openrewrite-recipes.adoc diff --git a/docs/topics/using-openrewrite-recipes.adoc b/docs/topics/using-openrewrite-recipes.adoc deleted file mode 100644 index acac0af961..0000000000 --- a/docs/topics/using-openrewrite-recipes.adoc +++ /dev/null @@ -1,59 +0,0 @@ -// Module included in the following module: -// -// * docs/cli-guide-mtr/master.adoc - -[id=using-openrewrite-recipes_{context}] -= Using OpenRewrite recipes - -[IMPORTANT] -==== -OpenRewrite recipe support is provided as Technology Preview only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs), might not be functionally complete, and Red Hat does not recommend to use them for production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. - -See link:{KBArticleTechnologyPreview}[Technology Preview features support scope] on the Red Hat Customer Portal for information about the support scope for Technology Preview features. -==== - -You can refactor the source code of Java applications by using link:https://docs.openrewrite.org/[OpenRewrite] recipes with the {ProductShortName} CLI. - -For example, the OpenRewrite recipe `org.jboss.windup.JavaxToJakarta` renames imported `javax` packages to their `jakarta` equivalents. - -.Procedure - -. Run `{mta-cli}`, specifying the recipe name, the path to the configuration file, and the application: -+ -[source,terminal,subs="attributes+"] ----- -$ ./{mta-cli} transform openrewrite --input \ - "-Drewrite.configLocation=" \ - "-DactiveRecipes=" --goal dryRun ----- - -* `"-DactiveRecipes="`: Specify the OpenRewrite recipe, for example, `org.jboss.windup.JavaxToJakarta`. - -* `--input`: Specify the application to be refactored. The application must be the top of the source code project containing a Maven Project Object Model (POM) XML file, `pom.xml`. - -* `-Drewrite.configLocation=` : The location of the `rewrite.yaml` configuration file to use. - The shipped `rewrite.yaml` configuration files are located in your -`<{ProductShortName}_HOME>/rules/openrewrite` subfolder, for example,`" -Drewrite.configLocation=<{ProductShortName}_HOME>/rules/openrewrite/jakarta/javax/imports/rewrite.yaml"`. - -* `"-DactiveRecipes="`: Specify the OpenRewrite recipe, for example, `org.jboss.windup.JavaxToJakarta`. -+ -You can include more than one recipe by specifying each in the `activeRecipes` parameter. For example, to include the recipes `org.jboss.windup.JavaxInjectToJakartaInject` and `org.jboss.windup.JavaxEjbToJakartaEjb"`, enter the following for `"-DactiveRecipes="`: -+ -[source, terminal,subs="attributes+"] ----- - "-DactiveRecipes=org.jboss.windup.JavaxInjectToJakartaInject, \ - org.jboss.windup.JavaxEjbToJakartaEjb" ----- - -* `--goal`: Optional: The OpenRewrite Maven goal to run. -** `dryRun` : The script returns a list of proposed changes. Ignore the `"Run 'mvn rewrite:run' to apply the recipes"` message. -** `run`: The script applies the changes. - -. Run `{mta-cli}` with `--goal run` to apply the recipe: -+ -[source,terminal,subs="attributes+"] ----- -$ ./{mta-cli} --openrewrite --input \ - "-Drewrite.configLocation=" \ - "-DactiveRecipes=" --goal run ----- From 9dc3561c37de02925cd5fc0e3cce98735afd9dc8 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Mon, 12 Feb 2024 11:48:48 +0000 Subject: [PATCH 21/26] Update docs/cli-guide/master.adoc --- 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 03c97a8dca..4a35da3916 100644 --- a/docs/cli-guide/master.adoc +++ b/docs/cli-guide/master.adoc @@ -44,7 +44,7 @@ include::topics/mta-cli-analyze.adoc[leveloffset=+3] include::topics/mta-cli-transform.adoc[leveloffset=+3] // Use OpenRewrite recipes -include::topics/mta-using-openrewrite-recipes.adoc[leveloffset=+3] +// include::topics/mta-using-openrewrite-recipes.adoc[leveloffset=+3] // Available OpenRewrite recipes include::topics/available-openrewrite-recipes.adoc[leveloffset=+4] From 6f95b0681cb4f0050f5186fabf1fd4687ddd2ea0 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Tue, 13 Feb 2024 23:53:34 +0000 Subject: [PATCH 22/26] Update mta-cli-run.adoc --- docs/topics/mta-cli-run.adoc | 63 ------------------------------------ 1 file changed, 63 deletions(-) diff --git a/docs/topics/mta-cli-run.adoc b/docs/topics/mta-cli-run.adoc index cb7438941f..5acdda3c27 100644 --- a/docs/topics/mta-cli-run.adoc +++ b/docs/topics/mta-cli-run.adoc @@ -67,67 +67,4 @@ $ <{ProductShortName}_HOME>/{mta-cli} analyze --input /path/to/jee-example-app-1 --target eap7 ---- [] -//// -[discrete] -=== Overriding {ProductShortName} properties - -To override the default _Fernflower_ decompiler, pass the `-Dwindup.decompiler` argument on the command line. For example, to use the _Procyon_ decompiler, use the following syntax: - -[source,terminal,subs="attributes+"] ----- -$ <{ProductShortName}_HOME>/{mta-cli} -Dwindup.decompiler=procyon \ - --input --output \ ----- -//// -//// -[id="cli-bash-completion_{context}"] -== {ProductShortName} {CLINameTitle} Bash completion - -The {ProductShortName} {CLIName} provides an option to enable Bash completion for Linux systems, allowing the {ProductShortName} command-line arguments to be auto completed by pressing the Tab key when entering the commands. For instance, when Bash completion is enabled, entering the following displays a list of available arguments. - -[source,terminal,subs="attributes+"] ----- -$ <{ProductShortName}_HOME>/{mta-cli} [TAB] ----- - -[discrete] -[id="bash-completion-temporary_{context}"] -=== Enabling Bash completion - -To enable Bash completion for the current shell, execute the following command: - -[source,terminal,subs="attributes+"] ----- -$ source <{ProductShortName}_HOME>/bash-completion/{mta-cli} ----- -[discrete] -[id="bash-completion-persistent_{context}"] -=== Enabling persistent Bash completion - -The following commands allow Bash completion to persist across restarts: - -* To enable Bash completion for a specific user across system restarts, include the following line in that user's `~/.bashrc` file. -+ -[source,terminal,subs="attributes+"] ----- -source <{ProductShortName}_HOME>/bash-completion/{mta-cli} ----- - -* To enable Bash completion for all users across system restarts, copy the {ProductName} {CLIName} Bash completion file to the `/etc/bash_completion.d/` directory as the root user. -+ -[source,terminal,subs="attributes+"] ----- -# cp <{ProductShortName}_HOME>/bash-completion/{mta-cli} /etc/bash_completion.d/ ----- - -[id="accessing-help_{context}"] -== Accessing {ProductShortName} help - -To see the complete list of available arguments for the `{mta-cli}` command, open a terminal, navigate to the `<{ProductShortName}_HOME>` directory, and execute the following command: - -[source,terminal,subs="attributes+"] ----- -$ <{ProductShortName}_HOME>/{mta-cli} --help ----- -//// From 6d3c79d41164b34cac31a1f88a454aec41b7dc90 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Tue, 13 Feb 2024 23:55:32 +0000 Subject: [PATCH 23/26] Update mta-cli-run.adoc --- docs/topics/mta-cli-run.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/topics/mta-cli-run.adoc b/docs/topics/mta-cli-run.adoc index 5acdda3c27..df4868c8dc 100644 --- a/docs/topics/mta-cli-run.adoc +++ b/docs/topics/mta-cli-run.adoc @@ -46,12 +46,12 @@ $ <{ProductShortName}_HOME>/{mta-cli} analyze \ [discrete] === Running {ProductShortName} on source code -The following command analyzes the `org.jboss.seam` packages of the link:https://github.com/windup/windup/tree/master/test-files/seam-booking-5.2[seam-booking-5.2] example source code for migrating to JBoss EAP 6. +The following command analyzes the link:https://github.com/windup/windup/tree/master/test-files/seam-booking-5.2[seam-booking-5.2] example source code for migrating to JBoss EAP 6. [source,terminal,subs="attributes+"] ---- -$ <{ProductShortName}_HOME>/bin/{mta-cli} analyze --mode source-only --input /path/to/seam-booking-5.2/ \ +$ <{ProductShortName}_HOME>/{mta-cli} analyze --mode source-only --input /path/to/seam-booking-5.2/ \ --output /path/to/report-output/ --target eap6 --packages org.jboss.seam ---- [] From 44e278e69c866d2d71521486bf2973f700e86c9c Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Tue, 13 Feb 2024 23:56:45 +0000 Subject: [PATCH 24/26] Update mta-cli-run.adoc --- docs/topics/mta-cli-run.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/mta-cli-run.adoc b/docs/topics/mta-cli-run.adoc index df4868c8dc..3c34758e09 100644 --- a/docs/topics/mta-cli-run.adoc +++ b/docs/topics/mta-cli-run.adoc @@ -33,7 +33,7 @@ $ ./{mta-cli} analyze --input /path/to/jee-example-app-1.0.0.ear \ [discrete] === Running {ProductShortName} on an application archive -The following command analyzes the `com.acme` and `org.apache` packages of the link:https://github.com/windup/windup/blob/master/test-files/jee-example-app-1.0.0.ear[jee-example-app-1.0.0.ear] example EAR archive for migrating from JBoss EAP 5 to JBoss EAP 7: +The following command analyzes the link:https://github.com/windup/windup/blob/master/test-files/jee-example-app-1.0.0.ear[jee-example-app-1.0.0.ear] example EAR archive for migrating from JBoss EAP 5 to JBoss EAP 7: [source,terminal,subs="attributes+"] ---- From b545e318e06ca2ded296888e2cb0f3f2c246e0be Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Tue, 13 Feb 2024 23:59:08 +0000 Subject: [PATCH 25/26] Update docs/topics/cli-run.adoc --- docs/topics/cli-run.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/cli-run.adoc b/docs/topics/cli-run.adoc index 76cd067ac9..92f33f12bd 100644 --- a/docs/topics/cli-run.adoc +++ b/docs/topics/cli-run.adoc @@ -68,7 +68,7 @@ The following command analyzes the `com.acme` and `org.apache` packages of the l [source,terminal,subs="attributes+"] ---- -$ <{ProductShortName}_HOME>/bin/windup-cli --input /path/to/jee-example-app-1.0.0.ear \ +$ <{ProductShortName}_HOME>/windup-cli --input /path/to/jee-example-app-1.0.0.ear \ --output /path/to/report-output/ \ --target eap:7 --target cloud-readiness --packages com.acme org.apache From 9cc31bc1d0e66a1b73da891a9ffb4a9e48d63e42 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Wed, 14 Feb 2024 00:00:43 +0000 Subject: [PATCH 26/26] Update mta-cli-run.adoc --- docs/topics/mta-cli-run.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/mta-cli-run.adoc b/docs/topics/mta-cli-run.adoc index 3c34758e09..e72214444d 100644 --- a/docs/topics/mta-cli-run.adoc +++ b/docs/topics/mta-cli-run.adoc @@ -58,7 +58,7 @@ $ <{ProductShortName}_HOME>/{mta-cli} analyze --mode source-only --input /path/t [discrete] === Running cloud-readiness rules -The following command analyzes the `com.acme` and `org.apache` packages of the link:https://github.com/windup/windup/blob/master/test-files/jee-example-app-1.0.0.ear[jee-example-app-1.0.0.ear] example EAR archive for migrating to JBoss EAP 7. It also evaluates for cloud readiness: +The following command analyzes the link:https://github.com/windup/windup/blob/master/test-files/jee-example-app-1.0.0.ear[jee-example-app-1.0.0.ear] example EAR archive for migrating to JBoss EAP 7. It also evaluates for cloud readiness: [source,terminal,subs="attributes+"] ----