Skip to content

Commit 69e8f0f

Browse files
author
Mariya Pershina
committed
Adding a separate chapter + 2 procedures
1 parent 32a7092 commit 69e8f0f

5 files changed

+82
-33
lines changed

docs/cli-guide/master.adoc

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,6 @@ include::topics/mta-cli-run.adoc[leveloffset=+2]
4343
// Analyze application source code
4444
include::topics/mta-cli-analyze.adoc[leveloffset=+3]
4545

46-
// Select language providers for the multi-application analysis
47-
include::topics/proc_selecting-language-providers-for-analysis.adoc[leveloffset=+3]
48-
4946
// Transform XML rules to YAML
5047
include::topics/mta-cli-transform.adoc[leveloffset=+3]
5148

@@ -58,6 +55,15 @@ include::topics/available-openrewrite-recipes.adoc[leveloffset=+4]
5855
// Access the Report
5956
include::topics/access-report.adoc[leveloffset=+2]
6057

58+
// Multi-language application analysis
59+
include::topics/mta-cli-analyze-multi-lang-apps.adoc[leveloffset=+2]
60+
61+
// Multi-language application analysis for the supported provider
62+
include::topics/mta-cli-analyze-selected-provider.adoc[leveloffset=+3]
63+
64+
// Multi-language application analysis for the unsupported provider
65+
include::topics/mta-cli-analyze-unsupported-provider.adoc[leveloffset=+3]
66+
6167
// Review the Reports
6268
include::topics/mta-review-reports.adoc[leveloffset=+1]
6369

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
:_newdoc-version: 2.18.3
2+
:_template-generated: 2024-07-30
3+
:_mod-docs-content-type: PROCEDURE
4+
5+
[id="mta-cli-analyze-multi-lang-apps_{context}"]
6+
= Analyzing multi-language applications with {CLIName}
7+
8+
You can run the application analysis on applications written in multiple languages. You can perform the analysis either of the following ways:
9+
10+
* Select the supported language provider to run the analysis for.
11+
* Override the existing supported language provider with your own unsupported language provider and run the analysis for this unsupported provider.
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
:_newdoc-version: 2.18.3
2+
:_template-generated: 2024-07-25
3+
:_mod-docs-content-type: PROCEDURE
4+
5+
[id="selecting-language-providers-for-analysis_{context}"]
6+
= Analyzing a multi-language application for the selected supported language provider
7+
8+
When analyzing a multi-language application with {ProductFullName} {CLINameTitle}, you can explicitly set a supported language provider according to your application language to run the analysis for.
9+
10+
11+
.Prerequisites
12+
13+
* You have the following software installed on your system:
14+
** Python
15+
** Skopeo
16+
** jq
17+
** oc
18+
** Podman
19+
* You are running the latest version of {ProductShortName} {CLINameTitle}.
20+
21+
22+
.Procedure
23+
24+
. List language providers supported for the analysis:
25+
+
26+
[source,terminal,subs="attributes+"]
27+
----
28+
$ mta-cli analyze --list-providers
29+
----
30+
31+
. Run the application analysis for the selected language provider:
32+
+
33+
[source,terminal,subs="attributes+"]
34+
----
35+
$ mta-cli analyze --input <_path_to_the_source_repository_> --output <_path_to_the_output_directory_> --provider <_language_provider_> --rules <_path_to_custom_rules_>
36+
----
37+
+
38+
Note that if you do not set the `--provider` option, the analysis fails because it detects unsupported providers.
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
:_newdoc-version: 2.18.3
2+
:_template-generated: 2024-07-30
3+
:_mod-docs-content-type: PROCEDURE
4+
5+
[id="mta-cli-analyze-unsupported-provider_{context}"]
6+
= Analyzing a multi-language application for an unsupported language provider
7+
8+
When analyzing a multi-language application with {ProductFullName} {CLINameTitle}, you can run the analysis for an unsupported language provider. To do so, you must override an existing supported language provider with your own unsupported language provider by using the `--provider-override` option.
9+
10+
IMPORTANT: You must create a configuration file for your unsupported language provider before overriding the supported provider.
11+
12+
13+
.Prerequisites
14+
15+
* You created a configuration file for your unsupported language provider.
16+
17+
.Procedure
18+
19+
* Override an existing supported language provider with your unsupported provider:
20+
+
21+
[source,terminal,subs="attributes+"]
22+
----
23+
$ mta-cli analyze --provider-override <path_to_configuration_file> --output=<path_to_the_output_directory> --rules <path_to_custom_rules>
24+
----

docs/topics/proc_selecting-language-providers-for-analysis.adoc

Lines changed: 0 additions & 30 deletions
This file was deleted.

0 commit comments

Comments
 (0)