Skip to content

Commit 0cb83ea

Browse files
authored
Merge pull request #78 from migtools/MTA-4250_QE-feedback-CLI
[To be merged for 7.1] QE feedback for the CLI guide
2 parents 41f536a + f41f87b commit 0cb83ea

File tree

5 files changed

+17
-7
lines changed

5 files changed

+17
-7
lines changed

docs/topics/installing-cli-tool.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ When you encounter `<{ProductShortName}_HOME>` in this guide, replace it with th
3131

3232

3333
[id="installing-using-podman_{context}"]
34-
== Installing the {CLINameTitle} using Podman
34+
== Installing the {CLINameTitle} by using Podman
3535

3636
You can install the {CLINameTitle} using `podman pull`.
3737

docs/topics/mta-cli-analyze-multi-lang-apps.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
[id="mta-cli-analyze-multi-lang-apps_{context}"]
66
= Analyzing multi-language applications with {CLIName}
77

8-
You can run the application analysis on applications written in multiple languages. You can perform the analysis either of the following ways:
8+
Starting from {ProductShortName} 7.1.0, you can run the application analysis on applications written in multiple languages. You can perform the analysis either of the following ways:
99

1010
* Select the supported language provider to run the analysis for.
1111
* Override the existing supported language provider with your own unsupported language provider and run the analysis for this unsupported provider.
12+

docs/topics/mta-cli-analyze.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
[id="mta-cli-analyze_{context}"]
77
= Performing analysis using the command line
88

9-
`Analyze` supports running source code and binary analysis using `analyzer-lsp`.
9+
`Analyze` supports running source code and binary analysis by using the `analyzer-lsp` tool. `analyzer-lsp` evaluates the rules for the providers and determines rule matches.
10+
1011

1112
.To run analysis on application source code, run the following command:
1213

docs/topics/mta-cli-transform.adoc

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,14 @@
44

55
:_mod-docs-content-type: CONCEPT
66
[id="mta-cli-transform_{context}"]
7-
= Performing transformation using the command line
7+
= Performing transformation by using the command line
88

9-
Transform has two subcommands - `openrewrite` and `rules`.
9+
You can use transformation to perform the following actions:
10+
11+
* Transform Java applications source code by using the `transform openrewrite` command.
12+
* Convert XML rules to YAML rules by using the `transform rules` command.
13+
14+
IMPORTANT: Performing transformation requires the container runtime to be configured. For more information, see xref:installing-using-podman_cli-guide[Installing the CLI by using Podman].
1015

1116
[source,terminal,subs="attributes+"]
1217
----
@@ -65,7 +70,10 @@ You can only use a single target to run the `transform overwrite` command.
6570

6671
== `Rules`
6772

68-
The `rules` subcommand allows converting {LC_PSN} XML rules to analyzer-lsp YAML rules using `windup-shim`.
73+
You can use the `rules` subcommand of the `transform` command to convert {LC_PSN} XML rules to `analyzer-lsp` YAML rules. To covert rules, the `rules` subcommand uses the `windup-shim` tool.
74+
75+
NOTE: `analyzer-lsp` evaluates the rules for the providers and determines rule matches.
76+
6977
[source,terminal,subs="attributes+"]
7078
----
7179
Convert XML rules to YAML

docs/topics/mta-review-reports.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="review-reports_{context}"]
77
= Reviewing the reports
88

9-
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.
9+
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.
1010

1111
ifdef::cli-guide[]
1212
The report was generated using the following command.

0 commit comments

Comments
 (0)