This is an automated email from the ASF dual-hosted git repository.
davidb pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/sling-org-apache-sling-feature-analyser.git
The following commit(s) were added to refs/heads/master by this push:
new 3d47ade Add some documentation for analyser tasks.
3d47ade is described below
commit 3d47ade8e565efcc3d894c17bed8b5c3779c56e1
Author: David Bosschaert <[email protected]>
AuthorDate: Wed Dec 12 13:50:50 2018 +0100
Add some documentation for analyser tasks.
---
readme.md | 40 +++++++++++++++++++++++++++++++++++++++-
1 file changed, 39 insertions(+), 1 deletion(-)
diff --git a/readme.md b/readme.md
index 17147f4..89f29f9 100644
--- a/readme.md
+++ b/readme.md
@@ -4,7 +4,7 @@
# Feature Model Analyser
-The Analyser can analyse a feature for completeness, to ensure all
requirements are satisfied by capabilities. The analyser is pluggable and can
also perform other checks.
+The Analyser can analyse features for completeness and correctness. The
analyser is pluggable and can also perform other checks.
The analyser can be run from the commandline by running the following main
class:
@@ -12,4 +12,42 @@ The analyser can be run from the commandline by running the
following main class
java org.apache.sling.feature.analyser.main.Main
```
+# Feature Model Analyser as a Maven Plugin
+
+The Analyser can also be run as part of a maven build via the
`slingfeature-maven-plugin`:
https://github.com/apache/sling-slingfeature-maven-plugin
+
+The following analysers are defined:
+
+* `bundle-packages`: Checks bundle import/export package statements for
consistency and completeness.
+
+* `bundle-content`: Gives a warning if a bundle container initial content
specified with `Sling-Initial-Content`.
+
+* `bundle-resources`: Gives a warning if a bundle contains resources specified
with `Sling-Bundle-Resources`.
+
+* `requirements-capabilities`: Checks bundle requirements/capabilities for
consistency and completeness.
+
+* `exported-packages`: Lists all packages in the feature and writes these to a
`packages.txt` file. This
+analyser task is not enabled by default.
+
+There are a number of analysers which relate to API Region definitions in
Feature Models.
+
+* `api-regions`: This analyser ensures that packages listed as exports in
API-Regions sections are actually exported by a bundle that's part of the
feature.
+
+* `api-regions-dependencies`: This analyser checks that packages in API
regions listed earlier in the API-Regions declaration have no dependency on API
regions listed later in the list. This include `Import-Package` style
dependencies and also uses-clause type dependencies. Later declarations also
include earlier declarations, but not the other way around.
+ * Configuration parameters:
+ * `exporting-apis`: the name of the region that provides the visible APIs.
+ * `hiding-apis`: the name of the region that is 'hidden' i.e. not as visible
as the exporting one. The
+packages in the `exporting-api` cannot depend on any packages from this
region.
+
+* `api-regions-duplicates`: This analyser ensures that packages are only
listed in one region
+in a given feature. If the same package is listed in multiple regions this
will be an error.
+
+* `api-regions-check-order`: This analyser checks that regions are defined in
the specified
+order and that the same region is only declared once. Later regions inherit
the packages
+expose in earlier regions in the list, so the order is important.
+ * Configuration parameters:
+ * `order`: A comma separated list of the region names declaring the order in
which they should be found. Not all regions declared must be present, but if
they are present this
+order must be obeyed.
+
+
For further documentation see:
https://github.com/apache/sling-org-apache-sling-feature/blob/master/readme.md
