Modified builtin xml fields and rulesets

Signed-off-by: Prabha Kylasamiyer Sundara Rajan <[email protected]>

Author: Prabha Kylasamiyer Sundara Rajan

assemblies/rules-development-guide/assembly_rule-rulesets.adoc

@@ -23,10 +23,6 @@ Note that if you want to use the `--target` or `--source` option in the CLI, the
 
 include::topics/rules-development/yaml-rulesets.adoc[leveloffset=+1]
 
-include::topics/rules-development/create-basic-yaml-ruleset-template.adoc[leveloffset=+1]
-
-include::topics/rules-development/running-analysis-using-custom-yaml-rule.adoc[leveloffset=+1]
-
 ifdef::parent-context-of-rule-rulesets[:context: {parent-context-of-rule-rulesets}]
 ifndef::parent-context-of-rule-rulesets[:!context:]
 

docs/topics/rules-development/yaml-provider-conditions.adoc

@@ -29,7 +29,7 @@ The analyzer currently supports the following `provider` conditions:
 * `python`
 * `dotnet`
 
-:FeatureName:Dotnet provider:
+:FeatureName: Dotnet provider
 include::developer-preview-admonition.adoc[]
 
 
@@ -265,15 +265,44 @@ when:
 .3+|xml
 |xpath
 |Yes
-|Xpath query
+a|Xpath query
+[source, yaml]
+----
+when:
+  builtin.xml:
+    xpath: "//dependencies/dependency"
+----
 
 |namespaces
 |No
-|A map to scope down query to namespaces.
+a|A map to scope down query to namespaces.
+[source, yaml]
+----
+when:
+  builtin.xml:
+    filepaths:
+     - beans.xml
+    namespaces:
+        b: http://xmlns.jcp.org/xml/ns/javaee
+    xpath: /b:beans
+----
 
 |filepaths
 |No
-|Optional list of files to scope down search.
+a|Optional list of files to scope down search.
+[source, yaml]
+----
+when:
+    or:
+    - builtin.xml:
+        xpath: "//dependencies/dependency"
+        filepaths: "{{poms.filepaths}}"
+      from: poms
+    - builtin.file:
+        pattern: pom.xml
+      as: poms
+      ignore: true
+----
 
 .2+|json
 |xpath

docs/topics/rules-development/yaml-rulesets.adoc

@@ -4,12 +4,12 @@
 
 :_mod-docs-content-type: REFERENCE
 [id="yaml-rulesets_{context}"]
-= Creating and using a ruleset
+= Creating and using a custom ruleset
 
 [role="_abstract"]
-You can create a ruleset by placing one or more YAML rules in a directory and creating a `ruleset.yaml` file at the directory root. When you pass this directory as input to the {ProductShortName} {CLIName} by using the `--rules` option, all rules in this directory are treated as a part of the ruleset defined by the `ruleset.yaml` file.
+You can create a ruleset by placing one or more custom rules in a directory and creating a `ruleset.yaml` file at the directory root. When you perform an analysis, you pass this directory as input to the {ProductShortName} {CLIName} by using the `--rules` option. All rules in this directory are treated as a part of the ruleset defined by the `ruleset.yaml` file.
 
-The `ruleset.yaml` file stores the metadata of the ruleset.
+The `ruleset.yaml` file stores the metadata of the ruleset. You can group multiple similar custom rules and create a ruleset for them. When you pass this directory as input to the {ProductShortName} {CLIName} using the `--rules` option, {ProductShortName} treats all the files in the directory as belonging to the ruleset defined in the `ruleset.yaml` file.
 
 [source,yaml]
 ----
@@ -32,6 +32,8 @@ $ mta-cli analyze --input=<application_to_analyze> --output=<output_dir> --rules
 
 *  Replace `<application_to_analyze>` with the name of your application.
 *  Replace `<output_dir>` with the directory of your choice.
-*  Replace `<custom_rule_dir>` with the custom rulesets file.
+*  Replace `<custom_rule_dir>` with the custom rule file.
+* To use multiple rule files, you need to place them in a directory and to add a `ruleset.yaml` file. Then the directory is treated as a _ruleset_, and you can pass it as input to the `--rules` option.
++
 
-On initiation, the mta-cli tool determines the type of application and the provider needed for analysis. It then starts the provider in a container that has the required dependencies and tools. Finally, the provider uses the analyzer to execute a series of rulesets to analyze the source code.
+Note that if you want to use the `--target` or `--source` option in the CLI, the engine will only select rules that match the label for that target. Therefore, make sure that you have added target or source labels on your rules. See xref:reserved-label_rule-yaml-metadata[Reserved labels] for more details.