From 6671fdcfbfe9445ba40d6c168a63b9ba69ce5ea2 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 20:14:24 +0000 Subject: [PATCH 01/34] MTA-2204-Changes-needed-for-mta-cli-docs Signed-off-by: Andy Arnold --- docs/cli-guide/master.adoc | 8 +- docs/topics/mta-cli-args.adoc | 210 ++++++++++++++++++ .../mta-exclude-files-and-packages.adoc | 20 ++ docs/topics/mta-optimize-performance.adoc | 28 +++ 4 files changed, 262 insertions(+), 4 deletions(-) create mode 100644 docs/topics/mta-cli-args.adoc create mode 100644 docs/topics/mta-exclude-files-and-packages.adoc create mode 100644 docs/topics/mta-optimize-performance.adoc diff --git a/docs/cli-guide/master.adoc b/docs/cli-guide/master.adoc index 503288d9ec..d48be1da0d 100644 --- a/docs/cli-guide/master.adoc +++ b/docs/cli-guide/master.adoc @@ -59,19 +59,19 @@ include::topics/review-reports.adoc[leveloffset=+1] include::topics/csv-export.adoc[leveloffset=+1] // Mavenize Your Application -include::topics/mavenize.adoc[leveloffset=+1] +// include::topics/mavenize.adoc[leveloffset=+1] // Optimize {ProductShortName} Performance -include::topics/optimize-performance.adoc[leveloffset=+1] +include::topics/mta-optimize-performance.adoc[leveloffset=+1] // Configure {ProductShortName} to Exclude Files and Packages -include::topics/exclude-files-and-packages.adoc[leveloffset=+2] +include::topics/mta-exclude-files-and-packages.adoc[leveloffset=+2] [appendix] == Reference material // {ProductShortName} Command-line Arguments -include::topics/cli-args.adoc[leveloffset=+2] +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] diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc new file mode 100644 index 0000000000..7ce82c095b --- /dev/null +++ b/docs/topics/mta-cli-args.adoc @@ -0,0 +1,210 @@ +// Module included in the following assemblies: +// +// * docs/cli-guide/master.adoc + +:_content-type: REFERENCE +[id="cli-args_{context}"] += About {ProductShortName} command-line arguments + +The following is a detailed description of the available {ProductShortName} command line arguments. + +[NOTE] +==== +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",] +|==== +|Argument |Description +|--additionalClassPath |A space-delimited list of additional JAR files or directories to add to the class path so that they are available for decompilation or other analysis. +|--addonDir |Add the specified directory as a custom add-on repository. +|--analyzeKnownLibraries | Flag to analyze known software artifacts embedded within your application. By default, {ProductShortName} only analyzes application code. + +[NOTE] +==== +This option may result in a longer execution time and a large number of migration issues being reported. +==== + +|--batchMode |Flag to specify that {ProductShortName} should be run in a non-interactive mode without prompting for confirmation. This mode takes the default values for any parameters not passed in to the command line. +|--debug |Flag to run {ProductShortName} in debug mode. +|--disableTattletale | Flag to disable generation of the Tattletale report. If both `enableTattletale` and `disableTattletale` are set to true, then `disableTattletale` will be ignored and the Tattletale report will still be generated. +|--discoverPackages |Flag to list all available packages in the input binary application. +|--enableClassNotFoundAnalysis |Flag to enable analysis of Java files that are not available on the class path. This should not be used if some classes will be unavailable at analysis time. +|--enableCompatibleFilesReport |Flag to enable generation of the Compatible Files report. Due to processing all files without found issues, this report may take a long time for large applications. +|--enableTattletale |Flag to enable generation of a Tattletale report for each application. This option is enabled by default when `eap` is in the included target. If both `enableTattletale` and `disableTattletale` are set to true, then `disableTattletale` will be ignored and the Tattletale report will still be generated. +|--enableTransactionAnalysis |[Technology Preview] Flag to enable generation of a Transactions report that displays the call stack, which executes operations on relational database tables. The Enable Transaction Analysis feature supports Spring Data JPA and the traditional `preparedStatement()` method for SQL statement execution. It does not support ORM frameworks, such as Hibernate. + +[NOTE] +==== +enableTransactionAnalysis is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them +in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. +==== + +|--excludePackages |A space-delimited list of packages to exclude from evaluation. For example, entering `com.mycompany.commonutilities` excludes all classes whose package names begin with `com.mycompany.commonutilities`. +|--excludeTags |A space-delimited list of tags to exclude. When specified, rules with these tags will not be processed. To see the full list of tags, use the `--listTags` argument. +|--explodedApp |Flag to indicate that the provided input directory contains source files for a single application. +|--exportCSV |Flag to export the report data to a CSV file on your local file system. {ProductShortName} creates the file in the directory specified by the `--output` argument. The CSV file can be imported into a spreadsheet program for data manipulation and analysis. +|--exportSummary |Flag to instruct {ProductShortName} to generate an `analysisSummary.json` export file in the output directory. The file contains analysis summary information for each application analyzed, including the number of incidents and story points by category, and all of the technology tags associated with the analyzed applications. +|--exportZipReport |This argument creates a `reports.zip` file in the output folder. The file contains the analysis output, typically, the reports. If requested, it can also contain the CSV export files. +|--help |Display the {ProductShortName} help message. +|--immutableAddonDir |Add the specified directory as a custom read-only add-on repository. +|--includeTags| A space-delimited list of tags to use. When specified, only rules with these tags will be processed. To see the full list of tags, use the `--listTags` argument. +|--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. +|--install |Specify add-ons to install. The syntax is `:[:]`. For example, `--install core-addon-x` or `--install org.example.addon:example:1.0.0`. +|--keepWorkDirs| Flag to instruct {ProductShortName} to not delete temporary working files, such as the graph database and extracted archive files. This is useful for debugging purposes. +|--legacyReports| Flag to instruct {ProductShortName} to generate the old format reports instead of the new format reports. +|--list| Flag to list installed add-ons. +|--listSourceTechnologies| Flag to list all available source technologies. +|--listTags| Flag to list all available tags. +|--listTargetTechnologies| Flag to list all available target technologies. +|--mavenize| Flag to create a Maven project directory structure based on the structure and content of the application. This creates `pom.xml` files using the appropriate Java EE API and the correct dependencies between project modules. See also the `--mavenizeGroupId` option. +|--mavenizeGroupId| When used with the `--mavenize` option, all generated `pom.xml` files will use the provided value for their ``. If this argument is omitted, {ProductShortName} will attempt to determine an appropriate `` based on the application, or will default to `com.mycompany.mavenized`. +|--online |Flag to allow network access for features that require it. Currently only validating XML schemas against external resources relies on Internet access. Note that this comes with a performance penalty. +|--output |Specify the path to the directory to output the report information generated by {ProductShortName}. +|--overwrite |Flag to force delete the existing output directory specified by `--output`. If you do not specify this argument and the `--output` directory exists, you are prompted to choose whether to overwrite the contents. + +[IMPORTANT] +==== +Do not overwrite a report output directory that contains important information. +==== + +|--packages| A space-delimited list of the packages to be evaluated by {ProductShortName}. It is highly recommended to use this argument. +|--remove |Remove the specified add-ons. The syntax is `:[:]`. For example, `--remove core-addon-x` or `--remove org.example.addon:example:1.0.0`. +|--skipReports |Flag to indicate that HTML reports should not be generated. A common use of this argument is when exporting report data to a CSV file using `--exportCSV`. +|--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. +|--sourceMode |Flag to indicate that the application to be evaluated contains source files rather than compiled binaries. The sourceMode argument has been deprecated. There is no longer the need to specify it. {ProductShortName} can intuitively process any inputs that are presented to it. In addition, project source folders can be analyzed with binary inputs within the same analysis execution. +|--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 `--listTargetTechnologies` argument to list all available targets. +|--userIgnorePath |Specify a location, in addition to `${user.home}/.{LC_PSN}/ignore/`, for {ProductShortName} to identify files that should be ignored. +|--userLabelsDirectory |Specify a location for {ProductShortName} to look for custom Target Runtime Labels. The value can be a directory containing label files or a single label file. The Target Runtime Label files must use the [x-]`.windup.label.xml` suffix. The shipped Target Runtime Labels are defined within `${ProductShortName}_HOME/rules/migration-core/core.windup.label.xml`. +|--userRulesDirectory |Specify a location, in addition to `<{ProductShortName}_HOME>/rules/` and `${user.home}/.{LC_PSN}/rules/`, for {ProductShortName} to look for custom {ProductShortName} rules. The value can be a directory containing ruleset files or a single ruleset file. The ruleset files must use the [x-]`.windup.xml` suffix. +|--version |Display the {ProductShortName} version. +|--skipSourceCodeReports |This option skips generating a _Source code report_ when generating the application analysis report. Use this advanced option when concerned about source code information appearing in the application analysis. +|==== + +[id="cli-input-argument_{context}"] +== Specifying the 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. + +.Usage +[source,options="nowrap",subs="attributes+"] +---- +--input [...] +---- + +[id="cli-input-file-type-arguments_{context}"] + +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. + +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. +|==== + +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 + +Specify the path to the directory to output the report information generated by {ProductShortName}. + +.Usage +[source,options="nowrap",subs="attributes+"] +---- +--output +---- + +* 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+"] +---- +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 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 `--listSourceTechnologies` argument to list all available sources. + +.Usage +[source,options="nowrap",subs="attributes+"] +---- +--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`. + +[WARNING] +==== +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. +==== + +[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. + +.Usage +[source,options="nowrap",subs="attributes+"] +---- +--target +---- + + +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`. + +[WARNING] +==== +When migrating to JBoss EAP, be sure to specify the version in the target, 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. +==== + +[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+"] +---- +--packages +---- + +* 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 like `org.apache`, it is usually best not to include them as they should not impact the migration effort. + +[WARNING] +==== +If you omit the `--packages` argument, every package in the application is scanned, which can impact performance. +==== diff --git a/docs/topics/mta-exclude-files-and-packages.adoc b/docs/topics/mta-exclude-files-and-packages.adoc new file mode 100644 index 0000000000..61601ea966 --- /dev/null +++ b/docs/topics/mta-exclude-files-and-packages.adoc @@ -0,0 +1,20 @@ +// Module included in the following assemblies: +// +// * docs/cli-guide/master.adoc + +:_content-type: PROCEDURE +[id="exclude-files-and-packages_{context}"] += Configuring {ProductShortName} to exclude packages and files + + +[id="ignored-locations_{context}"] +== Searching locations for exclusion + +{ProductShortName} searches the following locations: + +* `~/.{LC_PSN}/ignore/` +* `~/.windup/ignore/` +* `<{ProductShortName}_HOME>/ignore/` +* Any files and folders specified by the `--userIgnorePath` argument + +Each of these files must conform to the rules specified for excluding packages or files, depending on the type of content to be excluded. diff --git a/docs/topics/mta-optimize-performance.adoc b/docs/topics/mta-optimize-performance.adoc new file mode 100644 index 0000000000..092890868b --- /dev/null +++ b/docs/topics/mta-optimize-performance.adoc @@ -0,0 +1,28 @@ +// Module included in the following assemblies: +// +// * docs/cli-guide/master.adoc + +:_content-type: CONCEPT +[id="optimize-performance_{context}"] += Optimizing {ProductShortName} performance + +{ProductShortName} performance depends on a number of factors, including hardware configuration, the number and types of files in the application, the size and number of applications to be evaluated, and whether the application contains source or compiled code. For example, a file that is larger than 10 MB may need a lot of time to process. + +In general, {ProductShortName} spends about 40% of the time decompiling classes, 40% of the time executing rules, and the remainder of the time processing other tasks and generating reports. This section describes what you can do to improve the performance of {ProductShortName}. + +== Deploying and running the application + +Try these suggestions first before upgrading hardware. + +* If possible, run {ProductShortName} against the source code instead of the archives. This eliminates the need to decompile additional JARs and archives. +* Increase your ulimit when analyzing large applications. See link:https://access.redhat.com/solutions/60746[this Red Hat Knowledgebase article] for instructions on how to do this for Red Hat Enterprise Linux. +* If you have access to a server that has better resources than your laptop or desktop machine, you may want to consider running {ProductShortName} on that server. + +== Upgrading hardware + +If the application and command-line suggestions above do not improve performance, you may need to upgrade your hardware. + +* If you have access to a server that has better resources than your laptop/desktop, then you may want to consider running {ProductShortName} on that server. +* Very large applications that require decompilation have large memory requirements. 8 GB RAM is recommended. This allows 3 - 4 GB RAM for use by the JVM. +* An upgrade from a single or dual-core to a quad-core CPU processor provides better performance. +* Disk space and fragmentation can impact performance. A fast disk, especially a solid-state drive (SSD), with greater than 4 GB of defragmented disk space should improve performance. From 3636dbe5fe4a2755d6977eead0b170780a9fe189 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 21:42:26 +0000 Subject: [PATCH 02/34] MTA-2204-Changes-needed-for-mta-cli-docs Signed-off-by: Andy Arnold --- docs/cli-guide/master.adoc | 4 +- docs/topics/mta-cli-args.adoc | 18 +- docs/topics/mta-review-reports.adoc | 260 ++++++++++++++++++++++++++++ 3 files changed, 270 insertions(+), 12 deletions(-) create mode 100644 docs/topics/mta-review-reports.adoc diff --git a/docs/cli-guide/master.adoc b/docs/cli-guide/master.adoc index d48be1da0d..ebb0d05216 100644 --- a/docs/cli-guide/master.adoc +++ b/docs/cli-guide/master.adoc @@ -53,10 +53,10 @@ include::topics/available-openrewrite-recipes.adoc[leveloffset=+4] include::topics/access-report.adoc[leveloffset=+2] // Review the Reports -include::topics/review-reports.adoc[leveloffset=+1] +include::topics/mta-review-reports.adoc[leveloffset=+1] // Export the Report in CSV Format -include::topics/csv-export.adoc[leveloffset=+1] +// include::topics/csv-export.adoc[leveloffset=+1] // Mavenize Your Application // include::topics/mavenize.adoc[leveloffset=+1] diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index 7ce82c095b..43812d0b14 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -12,12 +12,12 @@ 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` ==== + .{ProductShortName} CLI arguments [cols="40%,60%a",options="header",] |==== @@ -104,26 +104,22 @@ Depending on whether the input file type provided to the `--input` argument is a Directory:: + -[cols="1,1,1",options="header"] +[cols="1,1",options="header"] |==== -| --explodedApp | --sourceMode -| Neither Argument +| No Argument -| 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"] +[cols="1,1",options="header"] |==== -| --explodedApp | --sourceMode -| Neither Argument +| No 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. |==== @@ -152,7 +148,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. 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. .Usage [source,options="nowrap",subs="attributes+"] @@ -190,6 +186,7 @@ When migrating to JBoss EAP, be sure to specify the version in the target, for e 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 @@ -208,3 +205,4 @@ A space-delimited list of the packages to be evaluated by {ProductShortName}. It ==== If you omit the `--packages` argument, every package in the application is scanned, which can impact performance. ==== +//// diff --git a/docs/topics/mta-review-reports.adoc b/docs/topics/mta-review-reports.adoc new file mode 100644 index 0000000000..17bd4a23c6 --- /dev/null +++ b/docs/topics/mta-review-reports.adoc @@ -0,0 +1,260 @@ +// Module included in the following assemblies: +// +// * docs/cli-guide/master.adoc + +:_content-type: PROCEDURE +[id="review-reports_{context}"] += Reviewing the reports + +The report examples shown in the following sections are a result of analyzing the `com.acme` and `org.apache` packages in the https://github.com/windup/windup/blob/master/test-files/jee-example-app-1.0.0.ear[jee-example-app-1.0.0.ear] example application, which is located in the {ProductShortName} GitHub source repository. + +ifdef::cli-guide[] +The report was generated using the following command. + +[options="nowrap",subs="attributes+"] +---- +$ <{ProductShortName}_HOME>/bin/{mta-cli} --input /home/username/{mta-cli}-source/test-files/jee-example-app-1.0.0.ear/ --output /home/username/{mta-cli}-reports/jee-example-app-1.0.0.ear-report --target eap:6 --packages com.acme org.apache +---- +endif::cli-guide[] + +Use a browser to open the `index.html` file located in the report output directory. This opens a landing page that lists the applications that were processed. Each row contains a high-level overview of the story points, number of incidents, and technologies encountered in that application. + +.Application list +image::3-1-applications.png[Application list] + +NOTE: The incidents and estimated story points change as new rules are added to {ProductShortName}. The values here may not match what you see when you test this application. + +The following table lists all of the reports and pages that can be accessed from this main {ProductShortName} landing page. Click the name of the application, *jee-example-app-1.0.0.ear*, to view the application report. + +[cols="30%,70%", options="header"] +|==== +| Page +| How to Access + +|Application +| Click the name of the application. + +| Technologies report +| Click the *Technologies* link at the top of the page. + +| Archives shared by multiple applications +| Click the *Archives shared by multiple applications* link. Note that this link is only available when there are shared archives across multiple applications. + +| Rule providers execution overview +| Click the *Rule providers execution overview* link at the bottom of the page. +|==== + +Note that if an application shares archives with other analyzed applications, you will see a breakdown of how many story points are from shared archives and how many are unique to this application. + +.Shared archives +image::3-2-shared-archives.png[Shared archives] + +Information about the archives that are shared among applications can be found in the Archives Shared by Multiple Applications reports. + +[id="review-application-report_{context}"] +== Application report + +=== Dashboard + +Access this report from the report landing page by clicking on the application name in the *Application List*. + +The dashboard gives an overview of the entire application migration effort. It summarizes: + +* The incidents and story points by category +* The incidents and story points by level of effort of the suggested changes +* The incidents by package + +.Dashboard +image::3-3-dashboard.png[Dashboard] + +The top navigation bar lists the various reports that contain additional details about the migration of this application. Note that only those reports that are applicable to the current application will be available. + +[cols="30%,70%", options="header"] +|==== +| Report +| Description + +| Issues +| Provides a concise summary of all issues that require attention. + +| Application details +| Provides a detailed overview of all resources found within the application that may need attention during the migration. + +| Technologies +| Displays all embedded libraries grouped by functionality, allowing you to quickly view the technologies used in each application. + +| Dependencies +| Displays all Java-packaged dependencies found within the application. + +| Unparsable +| Shows all files that {ProductShortName} could not parse in the expected format. For instance, a file with a `.xml` or `.wsdl` suffix is assumed to be an XML file. If the XML parser fails, the issue is reported here and also where the individual file is listed. + +| Remote services +| Displays all remote services references that were found within the application. + +| EJBs +| Contains a list of EJBs found within the application. + +| JBPM +| Contains all of the JBPM-related resources that were discovered during analysis. + +| JPA +| Contains details on all JPA-related resources that were found in the application. + +| Hibernate +| Contains details on all Hibernate-related resources that were found in the application. + +| Server resources +| Displays all server resources (for example, JNDI resources) in the input application. + +| Spring Beans +| Contains a list of Spring Beans found during the analysis. + +| Hard-coded IP addresses +| Provides a list of all hard-coded IP addresses that were found in the application. + +| Ignored files +ifdef::cli-guide[] +| Lists the files found in the application that, based on certain rules and {ProductShortName} configuration, were not processed. See the `--userIgnorePath` option for more information. +endif::[] +ifdef::maven-guide[] +| Lists the files found in the application that, based on certain rules and {ProductShortName} configuration, were not processed. See the `userIgnorePath` option for more information. +endif::[] + +| About +| Describes the current version of {ProductShortName} and provides helpful links for further assistance. +|==== + +[id="issues-report_{context}"] +=== Issues report + +Access this report from the dashboard by clicking the *Issues* link. + +This report includes details about every issue that was raised by the selected migration paths. The following information is provided for each issue encountered: + +* A title to summarize the issue. +* The total number of incidents, or times the issue was encountered. +* The rule story points to resolve a single instance of the issue. +* The estimated level of effort to resolve the issue. +* The total story points to resolve every instance encountered. This is calculated by multiplying the number of incidents found by the story points per incident. + +.Issues report +image::3-4-issues-report.png[Issues report] + +Each reported issue may be expanded, by clicking on the title, to obtain additional details. The following information is provided. + +* A list of files where the incidents occurred, along with the number of incidents within each file. If the file is a Java source file, then clicking the filename will direct you to the corresponding Source report. +* A detailed description of the issue. This description outlines the problem, provides any known solutions, and references supporting documentation regarding either the issue or resolution. +* A direct link, entitled *Show Rule*, to the rule that generated the issue. + +.Expanded issue +image::3-5-expanded-issue.png[Expanded rule in the issues report] + +Issues are sorted into four categories by default. Information on these categories is available at ask Category. + +=== Application details report + +Access this report from the dashboard by clicking the *Application Details* link. + +The report lists the story points, the Java incidents by package, and a count of the occurrences of the technologies found in the application. Next is a display of application messages generated during the migration process. Finally, there is a breakdown of this information for each archive analyzed during the process. + +.Application Details report +image::3-6-application-details-report.png[Application Details report] + +Expand the `jee-example-app-1.0.0.ear/jee-example-services.jar` to review the story points, Java incidents by package, and a count of the occurrences of the technologies found in this archive. This summary begins with a total of the story points assigned to its migration, followed by a table detailing the changes required for each file in the archive. The report contains the following columns. + +[cols="1,3", options="header"] +|==== +| Column Name +| Description + +| Name +| The name of the file being analyzed. + +| Technology +| The type of file being analyzed, for example, *Decompiled Java File* or *Properties*. + +| Issues +| Warnings about areas of code that need review or changes. + +| Story Points +a| Level of effort required to migrate the file. +|==== + +Note that if an archive is duplicated several times in an application, it will be listed just once in the report and will be tagged with `[Included multiple times]`. + +.Duplicate archive in an application +image::3-7-duplicate-archive-in-application.png[Duplicate archive] + +The story points for archives that are duplicated within an application will be counted only once in the total story point count for that application. + +//// +[id="technology-report-application_{context}"] +=== Technologies report + +Access this report from the dashboard by clicking the *Technologies* link. + +The report lists the occurrences of technologies, grouped by function, in the analyzed application. It is an overview of the technologies found in the application, and is designed to assist users in quickly understanding each application's purpose. + +The image below shows the technologies used in the `jee-example-app`. + +.Technologies in an application +image::3-8-technologies-in-application.png[Technology report Application view] + +=== Transactions report + +A Transactions report displays the call stack, which executes operations on relational database tables. The Enable Transaction Analysis feature supports Spring Data JPA and the traditional `preparedStatement()` method for SQL statement execution. It does not support ORM frameworks, such as Hibernate. + +ifdef::mta[] +The image below shows an example of a Transactions report. + +.Transactions report +image::transaction-report.png[Transactions report] +endif::[] + +ifdef::mtr[] +The image below shows an example of a Transactions report. + +.Transactions report +image::3-9-transaction-report-mtr.png[Transactions report] +endif::[] +=== Source report + +The Source report displays the migration issues in the context of the source file in which they were discovered. + +.Source report +image::3-10-source-report.png[Source Report] + +[id="technology-report_{context}"] +== Technologies report + +Access this report from the report landing page by clicking the *Technologies* link. + +This report provides an aggregate listing of the technologies used, grouped by function, for the analyzed applications. It shows how the technologies are distributed, and is typically reviewed after analyzing a large number of applications to group the applications and identify patterns. It also shows the size, number of libraries, and story point totals of each application. + +Clicking any of the headers, such as *Markup*, sorts the results in descending order. Selecting the same header again will resort the results in ascending order. The currently selected header is identified in bold, next to a directional arrow, indicating the direction of the sort. + +.Technologies used across multiple applications +image::3-11-technologies-used-across-multiple-applications.png[Technologies used across multiple applications] +//// + + +[id="shared-archives_{context}"] +== Archives shared by multiple applications + +Access these reports from the report landing page by clicking the *Archives shared by multiple applications* link. Note that this link is only available if there are applicable shared archives. + +.Archives shared by multiple applications +image::3-12-archives-shared-by-multiple-applications.png[Archives shared by multiple applications] + +This allows you to view the detailed reports for all archives that are shared across multiple applications. + +[id="review-rule-providers-execution-overview_{context}"] +== Rule providers execution overview + +Access this report from the report landing page by clicking the *Rule providers execution overview* link. + +This report provides the list of rules that ran when running the {ProductShortName} migration command against the application. + +.Rule providers execution overview +image::3-13-rule-providers-execution-overview.png[Rule Provider Execution Overview] From 824dcea1dd30e355bef02455daf375b2ea2075ad Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 21:47:23 +0000 Subject: [PATCH 03/34] Update Signed-off-by: Andy Arnold --- docs/topics/mta-cli-args.adoc | 8 -------- 1 file changed, 8 deletions(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index 43812d0b14..524df61589 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -38,14 +38,6 @@ This option may result in a longer execution time and a large number of migratio |--enableClassNotFoundAnalysis |Flag to enable analysis of Java files that are not available on the class path. This should not be used if some classes will be unavailable at analysis time. |--enableCompatibleFilesReport |Flag to enable generation of the Compatible Files report. Due to processing all files without found issues, this report may take a long time for large applications. |--enableTattletale |Flag to enable generation of a Tattletale report for each application. This option is enabled by default when `eap` is in the included target. If both `enableTattletale` and `disableTattletale` are set to true, then `disableTattletale` will be ignored and the Tattletale report will still be generated. -|--enableTransactionAnalysis |[Technology Preview] Flag to enable generation of a Transactions report that displays the call stack, which executes operations on relational database tables. The Enable Transaction Analysis feature supports Spring Data JPA and the traditional `preparedStatement()` method for SQL statement execution. It does not support ORM frameworks, such as Hibernate. - -[NOTE] -==== -enableTransactionAnalysis is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them -in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. -==== - |--excludePackages |A space-delimited list of packages to exclude from evaluation. For example, entering `com.mycompany.commonutilities` excludes all classes whose package names begin with `com.mycompany.commonutilities`. |--excludeTags |A space-delimited list of tags to exclude. When specified, rules with these tags will not be processed. To see the full list of tags, use the `--listTags` argument. |--explodedApp |Flag to indicate that the provided input directory contains source files for a single application. From 162ca20e9da12398b02b819b03f04e13586ed8e5 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 21:54:08 +0000 Subject: [PATCH 04/34] Update #2 Signed-off-by: Andy Arnold --- docs/topics/mta-cli-args.adoc | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index 524df61589..6f24946c9b 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -54,7 +54,7 @@ This option may result in a longer execution time and a large number of migratio |--list| Flag to list installed add-ons. |--listSourceTechnologies| Flag to list all available source technologies. |--listTags| Flag to list all available tags. -|--listTargetTechnologies| Flag to list all available target technologies. +|--list-targets| Flag to list all available target technologies. |--mavenize| Flag to create a Maven project directory structure based on the structure and content of the application. This creates `pom.xml` files using the appropriate Java EE API and the correct dependencies between project modules. See also the `--mavenizeGroupId` option. |--mavenizeGroupId| When used with the `--mavenize` option, all generated `pom.xml` files will use the provided value for their ``. If this argument is omitted, {ProductShortName} will attempt to determine an appropriate `` based on the application, or will default to `com.mycompany.mavenized`. |--online |Flag to allow network access for features that require it. Currently only validating XML schemas against external resources relies on Internet access. Note that this comes with a performance penalty. @@ -128,11 +128,11 @@ 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 and the `--overwrite` argument has not been provided, the command will return an error: + [source,options="nowrap",subs="attributes+"] ---- -Overwrite all contents of "/home/username/" (anything already in the directory will be deleted)? [y,N] +Error: output dir //home/username/ already exists and --overwrite not set ---- 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. @@ -148,11 +148,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 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 eap5`. [WARNING] ==== -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. +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. See link:{ProductDocIntroToMTAGuideURL}/index#migration_paths_getting-started-guide[Supported migration paths] in _{IntroToMTABookName}_ for the appropriate JBoss EAP version. ==== @@ -169,11 +169,11 @@ 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 eap7`. [WARNING] ==== -When migrating to JBoss EAP, be sure to specify the version in the target, for example, `eap:6`. 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 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. ==== From e2c3fb3b23ad289666f3af46e5df841678df9e53 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 21:55:27 +0000 Subject: [PATCH 05/34] Update docs/topics/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 6f24946c9b..08ef1e18de 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -160,7 +160,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. 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 `--list-targets` argument to list all available targets. .Usage [source,options="nowrap",subs="attributes+"] From 2200c28a03ed1e5c15d98b5d1b5b3e16c6011e0f Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 21:56:04 +0000 Subject: [PATCH 06/34] Update docs/topics/mta-exclude-files-and-packages.adoc --- docs/topics/mta-exclude-files-and-packages.adoc | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/topics/mta-exclude-files-and-packages.adoc b/docs/topics/mta-exclude-files-and-packages.adoc index 61601ea966..36f9fdb3f7 100644 --- a/docs/topics/mta-exclude-files-and-packages.adoc +++ b/docs/topics/mta-exclude-files-and-packages.adoc @@ -17,4 +17,3 @@ * `<{ProductShortName}_HOME>/ignore/` * Any files and folders specified by the `--userIgnorePath` argument -Each of these files must conform to the rules specified for excluding packages or files, depending on the type of content to be excluded. From 05a1f53ed7e5044d52cace5f6c87195cdefd8bd4 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 21:56:39 +0000 Subject: [PATCH 07/34] Update docs/topics/mta-cli-args.adoc --- docs/topics/mta-cli-args.adoc | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index 08ef1e18de..38dac73445 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -193,8 +193,4 @@ A space-delimited list of the packages to be evaluated by {ProductShortName}. It * 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 like `org.apache`, it is usually best not to include them as they should not impact the migration effort. -[WARNING] -==== -If you omit the `--packages` argument, every package in the application is scanned, which can impact performance. -==== //// From 98ea3fe1449c1e4997bb28ecc94cffea61cb5ca4 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 21:56:53 +0000 Subject: [PATCH 08/34] Update docs/topics/mta-exclude-files-and-packages.adoc --- docs/topics/mta-exclude-files-and-packages.adoc | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/topics/mta-exclude-files-and-packages.adoc b/docs/topics/mta-exclude-files-and-packages.adoc index 36f9fdb3f7..9a7c988c13 100644 --- a/docs/topics/mta-exclude-files-and-packages.adoc +++ b/docs/topics/mta-exclude-files-and-packages.adoc @@ -15,5 +15,4 @@ * `~/.{LC_PSN}/ignore/` * `~/.windup/ignore/` * `<{ProductShortName}_HOME>/ignore/` -* Any files and folders specified by the `--userIgnorePath` argument From 5c8ee26db16a520bca7a1b794c7d2a8d4057bbef Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 22:13:29 +0000 Subject: [PATCH 09/34] Update mta-cli-args.adoc --- docs/topics/mta-cli-args.adoc | 82 ++++++++++++++++++++++++++++------- 1 file changed, 67 insertions(+), 15 deletions(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index 38dac73445..162cd8cb71 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -91,31 +91,83 @@ A space-delimited list of the path to the file or directory containing one or mo ---- [id="cli-input-file-type-arguments_{context}"] +== Analyze application source code -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. +Usage: `{mta-cli} analyze [flags]` -Directory:: -+ -[cols="1,1",options="header"] +The following flags are available: + +.{ProductShortName} Analyze application +[cols="40%,60%a",options="header",] |==== -| --sourceMode -| No Argument +|Flag |Description + +| --analyze-known-libraries +| analyze known open-source libraries + +| -h, --help +| help for analyze + +| -i, --input string +| path to application source code or a binary + +| --json-output +| create analysis and dependency output as json + +| --list-sources +| list rules for available migration sources + +| --list-targets +| list rules for available migration targets + +| -l, --label-selector string +| run rules based on specified label selector expression + +| --maven-settings string +| path to a custom maven settings file to use + +| --overwrite +| overwrite output directory + +| --skip-static-report +| do not generate static report -| The directory is evaluated as a single application. -| Each subdirectory is evaluated as an application. +| -m, --mode string +| analysis mode" `full` (default) or `source-only` + +| -o, --output string | path to the directory for analysis output + +| --rules stringArray | filename or directory containing rule files + +| --skip-static-report +| do not generate static report + +| -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. |==== -File:: -+ -[cols="1,1",options="header"] +[id="cli-input-file-type-arguments-global-flags_{context}"] +=== Global flags + +.{ProductShortName} Analyze application +[cols="40%,60%a",options="header",] |==== -| --sourceMode -| No Argument -| The file is evaluated as a compressed project. -| The file is evaluated as a single application. +|Flag +|Description + +| --log-level uint32 +| log level (default 4) + +| --no-cleanup +| do not cleanup temporary resources |==== + + [id="cli-output-argument_{context}"] == Specifying the output directory From ad83d24a88dc7a868d9d15c2bd7becfee4b59dc4 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 23:28:34 +0000 Subject: [PATCH 10/34] Update docs/topics/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 162cd8cb71..9f32488ee8 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -24,7 +24,7 @@ To run the {ProductShortName} command without prompting, for example when execut |Argument |Description |--additionalClassPath |A space-delimited list of additional JAR files or directories to add to the class path so that they are available for decompilation or other analysis. |--addonDir |Add the specified directory as a custom add-on repository. -|--analyzeKnownLibraries | Flag to analyze known software artifacts embedded within your application. By default, {ProductShortName} only analyzes application code. +|--analyze-known-libraries | Flag to analyze known software artifacts embedded within your application. By default, {ProductShortName} only analyzes application code. [NOTE] ==== From fa33f50aca5f31e263f838381b535d56c28acb1c Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 23:29:25 +0000 Subject: [PATCH 11/34] 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 9f32488ee8..f6eaebc76d 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -52,7 +52,6 @@ This option may result in a longer execution time and a large number of migratio |--keepWorkDirs| Flag to instruct {ProductShortName} to not delete temporary working files, such as the graph database and extracted archive files. This is useful for debugging purposes. |--legacyReports| Flag to instruct {ProductShortName} to generate the old format reports instead of the new format reports. |--list| Flag to list installed add-ons. -|--listSourceTechnologies| Flag to list all available source technologies. |--listTags| Flag to list all available tags. |--list-targets| Flag to list all available target technologies. |--mavenize| Flag to create a Maven project directory structure based on the structure and content of the application. This creates `pom.xml` files using the appropriate Java EE API and the correct dependencies between project modules. See also the `--mavenizeGroupId` option. From 706be1d0edc9a968d9fe512da7cbd702f85c8d37 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 23:35:48 +0000 Subject: [PATCH 12/34] Update mta-cli-args.adoc --- docs/topics/mta-cli-args.adoc | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index f6eaebc76d..c365aeac1f 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -64,18 +64,11 @@ This option may result in a longer execution time and a large number of migratio ==== Do not overwrite a report output directory that contains important information. ==== - -|--packages| A space-delimited list of the packages to be evaluated by {ProductShortName}. It is highly recommended to use this argument. -|--remove |Remove the specified add-ons. The syntax is `:[:]`. For example, `--remove core-addon-x` or `--remove org.example.addon:example:1.0.0`. -|--skipReports |Flag to indicate that HTML reports should not be generated. A common use of this argument is when exporting report data to a CSV file using `--exportCSV`. +| --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. |--sourceMode |Flag to indicate that the application to be evaluated contains source files rather than compiled binaries. The sourceMode argument has been deprecated. There is no longer the need to specify it. {ProductShortName} can intuitively process any inputs that are presented to it. In addition, project source folders can be analyzed with binary inputs within the same analysis execution. |--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 `--listTargetTechnologies` argument to list all available targets. |--userIgnorePath |Specify a location, in addition to `${user.home}/.{LC_PSN}/ignore/`, for {ProductShortName} to identify files that should be ignored. -|--userLabelsDirectory |Specify a location for {ProductShortName} to look for custom Target Runtime Labels. The value can be a directory containing label files or a single label file. The Target Runtime Label files must use the [x-]`.windup.label.xml` suffix. The shipped Target Runtime Labels are defined within `${ProductShortName}_HOME/rules/migration-core/core.windup.label.xml`. -|--userRulesDirectory |Specify a location, in addition to `<{ProductShortName}_HOME>/rules/` and `${user.home}/.{LC_PSN}/rules/`, for {ProductShortName} to look for custom {ProductShortName} rules. The value can be a directory containing ruleset files or a single ruleset file. The ruleset files must use the [x-]`.windup.xml` suffix. -|--version |Display the {ProductShortName} version. -|--skipSourceCodeReports |This option skips generating a _Source code report_ when generating the application analysis report. Use this advanced option when concerned about source code information appearing in the application analysis. |==== [id="cli-input-argument_{context}"] From fd7c93da47b840b684cb7ef2e3711b581fb90025 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 23:38:58 +0000 Subject: [PATCH 13/34] 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 c365aeac1f..3d7d8f1d68 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -56,6 +56,7 @@ This option may result in a longer execution time and a large number of migratio |--list-targets| Flag to list all available target technologies. |--mavenize| Flag to create a Maven project directory structure based on the structure and content of the application. This creates `pom.xml` files using the appropriate Java EE API and the correct dependencies between project modules. See also the `--mavenizeGroupId` option. |--mavenizeGroupId| When used with the `--mavenize` option, all generated `pom.xml` files will use the provided value for their ``. If this argument is omitted, {ProductShortName} will attempt to determine an appropriate `` based on the application, or will default to `com.mycompany.mavenized`. +| -m, --mode string | Flag for analysis mode" `full` (default) or `source-only` |--online |Flag to allow network access for features that require it. Currently only validating XML schemas against external resources relies on Internet access. Note that this comes with a performance penalty. |--output |Specify the path to the directory to output the report information generated by {ProductShortName}. |--overwrite |Flag to force delete the existing output directory specified by `--output`. If you do not specify this argument and the `--output` directory exists, you are prompted to choose whether to overwrite the contents. @@ -66,7 +67,6 @@ 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. -|--sourceMode |Flag to indicate that the application to be evaluated contains source files rather than compiled binaries. The sourceMode argument has been deprecated. There is no longer the need to specify it. {ProductShortName} can intuitively process any inputs that are presented to it. In addition, project source folders can be analyzed with binary inputs within the same analysis execution. |--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 `--listTargetTechnologies` argument to list all available targets. |--userIgnorePath |Specify a location, in addition to `${user.home}/.{LC_PSN}/ignore/`, for {ProductShortName} to identify files that should be ignored. |==== From ffeda4a1dbee99709b1dbd393b90b37bdfc528e2 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 23:40:18 +0000 Subject: [PATCH 14/34] 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 3d7d8f1d68..3fe956e60e 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -31,7 +31,6 @@ To run the {ProductShortName} command without prompting, for example when execut This option may result in a longer execution time and a large number of migration issues being reported. ==== -|--batchMode |Flag to specify that {ProductShortName} should be run in a non-interactive mode without prompting for confirmation. This mode takes the default values for any parameters not passed in to the command line. |--debug |Flag to run {ProductShortName} in debug mode. |--disableTattletale | Flag to disable generation of the Tattletale report. If both `enableTattletale` and `disableTattletale` are set to true, then `disableTattletale` will be ignored and the Tattletale report will still be generated. |--discoverPackages |Flag to list all available packages in the input binary application. From 50a25fd1faf216a324ecb08b54d472c7f38cd3bc Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 23:41:01 +0000 Subject: [PATCH 15/34] Update docs/topics/mta-cli-args.adoc --- docs/topics/mta-cli-args.adoc | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index 3fe956e60e..ece34acf8d 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -22,8 +22,6 @@ To run the {ProductShortName} command without prompting, for example when execut [cols="40%,60%a",options="header",] |==== |Argument |Description -|--additionalClassPath |A space-delimited list of additional JAR files or directories to add to the class path so that they are available for decompilation or other analysis. -|--addonDir |Add the specified directory as a custom add-on repository. |--analyze-known-libraries | Flag to analyze known software artifacts embedded within your application. By default, {ProductShortName} only analyzes application code. [NOTE] From 77bf14a8327af62209ec63e838abe4a7c2b8eddb Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 23:42:31 +0000 Subject: [PATCH 16/34] 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 ece34acf8d..569d06fd70 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -56,7 +56,6 @@ This option may result in a longer execution time and a large number of migratio | -m, --mode string | Flag for analysis mode" `full` (default) or `source-only` |--online |Flag to allow network access for features that require it. Currently only validating XML schemas against external resources relies on Internet access. Note that this comes with a performance penalty. |--output |Specify the path to the directory to output the report information generated by {ProductShortName}. -|--overwrite |Flag to force delete the existing output directory specified by `--output`. If you do not specify this argument and the `--output` directory exists, you are prompted to choose whether to overwrite the contents. [IMPORTANT] ==== From 123272053009f671cbc2243cb7c64492c7cca9b9 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 23:44:11 +0000 Subject: [PATCH 17/34] Update docs/topics/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 569d06fd70..d607d4cd8a 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -200,7 +200,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 `--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 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. .Usage [source,options="nowrap",subs="attributes+"] From 9849fa5f385d933d544093519c15cfd0f57dc24e Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 23:46:29 +0000 Subject: [PATCH 18/34] Update docs/topics/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 d607d4cd8a..e221279341 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -167,7 +167,7 @@ Specify the path to the directory to output the report information generated by --output ---- -* If omitted, the report will be generated in an `.report` directory. +* The `--output` argument is mandatory. If omitted, an error is returned: * If the output directory exists and the `--overwrite` argument has not been provided, the command will return an error: + [source,options="nowrap",subs="attributes+"] From 9cd0e2b803dbb985e371313b6fafa5d1e714ed72 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 23:49:01 +0000 Subject: [PATCH 19/34] Update mta-cli-args.adoc --- docs/topics/mta-cli-args.adoc | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index e221279341..3511b992fa 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -168,11 +168,10 @@ Specify the path to the directory to output the report information generated by ---- * The `--output` argument is mandatory. If omitted, an error is returned: -* If the output directory exists and the `--overwrite` argument has not been provided, the command will return an error: + [source,options="nowrap",subs="attributes+"] ---- -Error: output dir //home/username/ already exists and --overwrite not set +Error: required flag(s) "output" not set ---- 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. From 215f6360cbdb1e255b3e4a59cb63e4ae2c419423 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 23:52:02 +0000 Subject: [PATCH 20/34] 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 ebb0d05216..14c138294f 100644 --- a/docs/cli-guide/master.adoc +++ b/docs/cli-guide/master.adoc @@ -65,7 +65,7 @@ include::topics/mta-review-reports.adoc[leveloffset=+1] 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] +// include::topics/mta-exclude-files-and-packages.adoc[leveloffset=+2] [appendix] == Reference material From 4b0ae10c31d2c5a9dc77bc2a509875534e03f9fd Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 23:57:51 +0000 Subject: [PATCH 21/34] Update docs/topics/mta-review-reports.adoc --- docs/topics/mta-review-reports.adoc | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/topics/mta-review-reports.adoc b/docs/topics/mta-review-reports.adoc index 17bd4a23c6..1eb21a5fcf 100644 --- a/docs/topics/mta-review-reports.adoc +++ b/docs/topics/mta-review-reports.adoc @@ -188,7 +188,6 @@ image::3-7-duplicate-archive-in-application.png[Duplicate archive] The story points for archives that are duplicated within an application will be counted only once in the total story point count for that application. -//// [id="technology-report-application_{context}"] === Technologies report From 6622f09f4a992b4466e80a14d8e0ed34ca6b4f7b Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Thu, 8 Feb 2024 23:58:15 +0000 Subject: [PATCH 22/34] 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 3511b992fa..9c43802964 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -226,7 +226,6 @@ A space-delimited list of the packages to be evaluated by {ProductShortName}. It .Usage [source,options="nowrap",subs="attributes+"] ---- ---packages ---- * 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. From 990cb882766dff779fe190f17d72037ef672d257 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Fri, 9 Feb 2024 00:04:01 +0000 Subject: [PATCH 23/34] Update mta-review-reports.adoc --- docs/topics/mta-review-reports.adoc | 17 ----------------- 1 file changed, 17 deletions(-) diff --git a/docs/topics/mta-review-reports.adoc b/docs/topics/mta-review-reports.adoc index 1eb21a5fcf..863f39c9ce 100644 --- a/docs/topics/mta-review-reports.adoc +++ b/docs/topics/mta-review-reports.adoc @@ -200,23 +200,6 @@ The image below shows the technologies used in the `jee-example-app`. .Technologies in an application image::3-8-technologies-in-application.png[Technology report Application view] -=== Transactions report - -A Transactions report displays the call stack, which executes operations on relational database tables. The Enable Transaction Analysis feature supports Spring Data JPA and the traditional `preparedStatement()` method for SQL statement execution. It does not support ORM frameworks, such as Hibernate. - -ifdef::mta[] -The image below shows an example of a Transactions report. - -.Transactions report -image::transaction-report.png[Transactions report] -endif::[] - -ifdef::mtr[] -The image below shows an example of a Transactions report. - -.Transactions report -image::3-9-transaction-report-mtr.png[Transactions report] -endif::[] === Source report The Source report displays the migration issues in the context of the source file in which they were discovered. From eb43b6e532d4bca68247b315697b7a1456e6adc3 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Fri, 9 Feb 2024 00:11:37 +0000 Subject: [PATCH 24/34] Remove Transactions report references Signed-off-by: Andy Arnold --- ...eb-configuring-and-running-an-application-analysis.adoc | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/docs/topics/mta-web-configuring-and-running-an-application-analysis.adoc b/docs/topics/mta-web-configuring-and-running-an-application-analysis.adoc index 1202d962a8..b79f460c93 100644 --- a/docs/topics/mta-web-configuring-and-running-an-application-analysis.adoc +++ b/docs/topics/mta-web-configuring-and-running-an-application-analysis.adoc @@ -75,13 +75,8 @@ Attaching custom rules is optional if you have already attached a migration targ * Target * Source(s) * Excluded rules tags: Rules with these tags are not processed. Add or delete as needed. -* Enable transaction report: Select the checkbox to generate a DIVA report that displays the call stack, which executes operations on relational database tables. * Enable automated tagging: Select the checkbox to automatically attach tags to the application. This checkbox is selected by default. -+ -[NOTE] -==== -The Transactions report is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. -==== + + [NOTE] ==== From 26756adcdaddf9677916cdb43f69f69ab32c92ea Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Fri, 9 Feb 2024 00:31:38 +0000 Subject: [PATCH 25/34] Update mta-cli-args.adoc --- docs/topics/mta-cli-args.adoc | 20 -------------------- 1 file changed, 20 deletions(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index 9c43802964..0c6908daec 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -29,32 +29,12 @@ To run the {ProductShortName} command without prompting, for example when execut This option may result in a longer execution time and a large number of migration issues being reported. ==== -|--debug |Flag to run {ProductShortName} in debug mode. -|--disableTattletale | Flag to disable generation of the Tattletale report. If both `enableTattletale` and `disableTattletale` are set to true, then `disableTattletale` will be ignored and the Tattletale report will still be generated. -|--discoverPackages |Flag to list all available packages in the input binary application. -|--enableClassNotFoundAnalysis |Flag to enable analysis of Java files that are not available on the class path. This should not be used if some classes will be unavailable at analysis time. -|--enableCompatibleFilesReport |Flag to enable generation of the Compatible Files report. Due to processing all files without found issues, this report may take a long time for large applications. -|--enableTattletale |Flag to enable generation of a Tattletale report for each application. This option is enabled by default when `eap` is in the included target. If both `enableTattletale` and `disableTattletale` are set to true, then `disableTattletale` will be ignored and the Tattletale report will still be generated. -|--excludePackages |A space-delimited list of packages to exclude from evaluation. For example, entering `com.mycompany.commonutilities` excludes all classes whose package names begin with `com.mycompany.commonutilities`. -|--excludeTags |A space-delimited list of tags to exclude. When specified, rules with these tags will not be processed. To see the full list of tags, use the `--listTags` argument. -|--explodedApp |Flag to indicate that the provided input directory contains source files for a single application. -|--exportCSV |Flag to export the report data to a CSV file on your local file system. {ProductShortName} creates the file in the directory specified by the `--output` argument. The CSV file can be imported into a spreadsheet program for data manipulation and analysis. -|--exportSummary |Flag to instruct {ProductShortName} to generate an `analysisSummary.json` export file in the output directory. The file contains analysis summary information for each application analyzed, including the number of incidents and story points by category, and all of the technology tags associated with the analyzed applications. -|--exportZipReport |This argument creates a `reports.zip` file in the output folder. The file contains the analysis output, typically, the reports. If requested, it can also contain the CSV export files. |--help |Display the {ProductShortName} help message. -|--immutableAddonDir |Add the specified directory as a custom read-only add-on repository. -|--includeTags| A space-delimited list of tags to use. When specified, only rules with these tags will be processed. To see the full list of tags, use the `--listTags` argument. |--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. -|--install |Specify add-ons to install. The syntax is `:[:]`. For example, `--install core-addon-x` or `--install org.example.addon:example:1.0.0`. -|--keepWorkDirs| Flag to instruct {ProductShortName} to not delete temporary working files, such as the graph database and extracted archive files. This is useful for debugging purposes. -|--legacyReports| Flag to instruct {ProductShortName} to generate the old format reports instead of the new format reports. -|--list| Flag to list installed add-ons. |--listTags| Flag to list all available tags. |--list-targets| Flag to list all available target technologies. |--mavenize| Flag to create a Maven project directory structure based on the structure and content of the application. This creates `pom.xml` files using the appropriate Java EE API and the correct dependencies between project modules. See also the `--mavenizeGroupId` option. -|--mavenizeGroupId| When used with the `--mavenize` option, all generated `pom.xml` files will use the provided value for their ``. If this argument is omitted, {ProductShortName} will attempt to determine an appropriate `` based on the application, or will default to `com.mycompany.mavenized`. | -m, --mode string | Flag for analysis mode" `full` (default) or `source-only` -|--online |Flag to allow network access for features that require it. Currently only validating XML schemas against external resources relies on Internet access. Note that this comes with a performance penalty. |--output |Specify the path to the directory to output the report information generated by {ProductShortName}. [IMPORTANT] From 0108a2b42021820fce3b63147766eea71b0d0124 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Fri, 9 Feb 2024 10:55:39 +0000 Subject: [PATCH 26/34] Update mta-review-reports.adoc --- docs/topics/mta-review-reports.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/mta-review-reports.adoc b/docs/topics/mta-review-reports.adoc index 863f39c9ce..5db1889498 100644 --- a/docs/topics/mta-review-reports.adoc +++ b/docs/topics/mta-review-reports.adoc @@ -13,7 +13,7 @@ The report was generated using the following command. [options="nowrap",subs="attributes+"] ---- -$ <{ProductShortName}_HOME>/bin/{mta-cli} --input /home/username/{mta-cli}-source/test-files/jee-example-app-1.0.0.ear/ --output /home/username/{mta-cli}-reports/jee-example-app-1.0.0.ear-report --target eap:6 --packages com.acme org.apache +$ <{ProductShortName}_HOME>/bin/{mta-cli} --input /home/username/{mta-cli}-source/test-files/jee-example-app-1.0.0.ear/ --output /home/username/{mta-cli}-reports/jee-example-app-1.0.0.ear-report --target eap6 --packages com.acme org.apache ---- endif::cli-guide[] From 3b2d567b5eb7db2a8870ac227fac89dcb5d8a894 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Fri, 9 Feb 2024 12:26:11 +0000 Subject: [PATCH 27/34] Update docs/topics/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 0c6908daec..d7c9f692ed 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -10,7 +10,7 @@ The following is a detailed description of the available {ProductShortName} comm [NOTE] ==== -To run the {ProductShortName} command without prompting, for example when executing from a script, you must use the following arguments: +To run the {ProductShortName} command, for example when executing from a script, you must use the following arguments: * `--overwrite` * `--input` From 8bf4df11e20edda9f69db82e1b7cb4c05ec356f3 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Fri, 9 Feb 2024 12:26:55 +0000 Subject: [PATCH 28/34] 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 d7c9f692ed..c522d2b393 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -31,7 +31,6 @@ This option may result in a longer execution time and a large number of migratio |--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. -|--listTags| Flag to list all available tags. |--list-targets| Flag to list all available target technologies. |--mavenize| Flag to create a Maven project directory structure based on the structure and content of the application. This creates `pom.xml` files using the appropriate Java EE API and the correct dependencies between project modules. See also the `--mavenizeGroupId` option. | -m, --mode string | Flag for analysis mode" `full` (default) or `source-only` From 996dbd91895926224145faf8cc3feb3e558c5e78 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Fri, 9 Feb 2024 12:28:33 +0000 Subject: [PATCH 29/34] Update mta-cli-args.adoc --- docs/topics/mta-cli-args.adoc | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index c522d2b393..deaa182e30 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -31,6 +31,8 @@ This option may result in a longer execution time and a large number of migratio |--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-targets| Flag to list all available target technologies. |--mavenize| Flag to create a Maven project directory structure based on the structure and content of the application. This creates `pom.xml` files using the appropriate Java EE API and the correct dependencies between project modules. See also the `--mavenizeGroupId` option. | -m, --mode string | Flag for analysis mode" `full` (default) or `source-only` @@ -40,8 +42,8 @@ This option may result in a longer execution time and a large number of migratio ==== 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. +| --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 `--listTargetTechnologies` argument to list all available targets. |--userIgnorePath |Specify a location, in addition to `${user.home}/.{LC_PSN}/ignore/`, for {ProductShortName} to identify files that should be ignored. |==== From ca18f02430f19fdf154cea77f60b762ee45c50f0 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Fri, 9 Feb 2024 12:31:45 +0000 Subject: [PATCH 30/34] 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 deaa182e30..a03be5e148 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -35,7 +35,6 @@ This option may result in a longer execution time and a large number of migratio | list rules for available migration sources |--list-targets| Flag to list all available target technologies. |--mavenize| Flag to create a Maven project directory structure based on the structure and content of the application. This creates `pom.xml` files using the appropriate Java EE API and the correct dependencies between project modules. See also the `--mavenizeGroupId` option. -| -m, --mode string | Flag for analysis mode" `full` (default) or `source-only` |--output |Specify the path to the directory to output the report information generated by {ProductShortName}. [IMPORTANT] From 8bf275f814d493dd97ba424cd646b6509f264954 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Fri, 9 Feb 2024 12:33:05 +0000 Subject: [PATCH 31/34] Update docs/topics/mta-cli-args.adoc --- docs/topics/mta-cli-args.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/topics/mta-cli-args.adoc b/docs/topics/mta-cli-args.adoc index a03be5e148..bff5be88c8 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -33,6 +33,7 @@ This option may result in a longer execution time and a large number of migratio |--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. |--mavenize| Flag to create a Maven project directory structure based on the structure and content of the application. This creates `pom.xml` files using the appropriate Java EE API and the correct dependencies between project modules. See also the `--mavenizeGroupId` option. |--output |Specify the path to the directory to output the report information generated by {ProductShortName}. From 295d1253f54d3707a7c8f4aa3e7f5182364a7831 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Fri, 9 Feb 2024 12:33:39 +0000 Subject: [PATCH 32/34] 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 bff5be88c8..aa033ea296 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -35,7 +35,6 @@ This option may result in a longer execution time and a large number of migratio | list rules for available migration sources |--list-sources | Flag to list all available source technologies. |--list-targets| Flag to list all available target technologies. -|--mavenize| Flag to create a Maven project directory structure based on the structure and content of the application. This creates `pom.xml` files using the appropriate Java EE API and the correct dependencies between project modules. See also the `--mavenizeGroupId` option. |--output |Specify the path to the directory to output the report information generated by {ProductShortName}. [IMPORTANT] From 3545e563fceeafe0626ed70a203542ae13e24c1d Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Fri, 9 Feb 2024 12:34:12 +0000 Subject: [PATCH 33/34] 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 aa033ea296..a5043e9a9f 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -44,7 +44,6 @@ 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 `--listTargetTechnologies` argument to list all available targets. -|--userIgnorePath |Specify a location, in addition to `${user.home}/.{LC_PSN}/ignore/`, for {ProductShortName} to identify files that should be ignored. |==== [id="cli-input-argument_{context}"] From f5b04b3d4105e25ac55f4fb30233c85979261bc5 Mon Sep 17 00:00:00 2001 From: Andy Arnold Date: Fri, 9 Feb 2024 12:35:21 +0000 Subject: [PATCH 34/34] Update docs/topics/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 a5043e9a9f..7b840c0f61 100644 --- a/docs/topics/mta-cli-args.adoc +++ b/docs/topics/mta-cli-args.adoc @@ -43,7 +43,7 @@ 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 `--listTargetTechnologies` argument to list all available targets. +|--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. |==== [id="cli-input-argument_{context}"]