Update documentation Change-Id: Ic608d16733581ae5afb8094c4794061b94149f99
diff --git a/src/main/resources/Documentation/about.md b/src/main/resources/Documentation/about.md index 76d21dd..27679cf 100644 --- a/src/main/resources/Documentation/about.md +++ b/src/main/resources/Documentation/about.md
@@ -25,15 +25,26 @@ used to provide system-level version metadata. One can also use "git bisect" on the branches to identify system-level regression. +The subject line of the change that triggered the snapshot manifest is included +in the commit message of the snapshot manifest. This way, you can get a summary +sequence of changes of all repository described by that manifest by running the +following git log command in the snapshot manifest branch: + +``` +git log --pretty=format:%b +``` + * Enabled by project.config in the manifest project to be monitored * Manifest class is generated from 'repo help manifest' DTD using JAXB +(part of the build step) * \<include\>s are expanded similar to "repo manifest -o" (only works for manifests in the same source manifest repository reference by relative path) * Supports \<remove-project\> -* Circular update loop is prevented by not monitoring any of the rev-specific +* Circular update loop is prevented by not monitoring any of the snapshot manifest repositories * Projects in the manifests are assumed to be on the server. (There is no check currently so it's a potential source of error.) +* Snapshot manifests are generated when the source manifests are updated ``` @@ -49,19 +60,15 @@ * TODO: strict mode, only monitor projects using default (no remote) * TODO: split mode (store all manifests in same branch structure as source instead of flattening the underlying file strcuture) * TODO: not monitor non-local projects +* TODO: provide hook for non-local projects to trigger snapshot update -* TODO: make sure no circular dependencies (project with manifest subscription is not in the -manifest being monitored.) -* TODO: support changes in manifest - -* resolve relative path in include -* supports include tag in manifest +* TODO: add something to prevent loop even if store repo is the same as source +manifest repo * TODO: check project.config on newly created project * TODO: include an external manifest DTD or XML schema/XSD -* generates/xjc classes from DTD/XSD at build time -* TODO add test verify include manifest have original project +* TODO add test verify manifest that can cause circular conditions * TODO sub dir include manifest have same level include working