Adds additional clarification to catalog docs
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/712a7559 Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/712a7559 Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/712a7559 Branch: refs/heads/master Commit: 712a75599aadf6432fddf73abc414b6e70af16f9 Parents: 10a10e5 Author: Martin Harris <[email protected]> Authored: Wed Jun 24 15:12:28 2015 +0100 Committer: Martin Harris <[email protected]> Committed: Fri Jun 26 11:17:23 2015 +0100 ---------------------------------------------------------------------- docs/guide/ops/catalog/index.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/712a7559/docs/guide/ops/catalog/index.md ---------------------------------------------------------------------- diff --git a/docs/guide/ops/catalog/index.md b/docs/guide/ops/catalog/index.md index e2fbc9c..d24e200 100644 --- a/docs/guide/ops/catalog/index.md +++ b/docs/guide/ops/catalog/index.md @@ -302,7 +302,16 @@ The `brooklyn` CLI includes several commands for working with the catalog. * `--catalogInitial <file.bom>` will set the catalog items to use on first run, on a catalog reset, or if persistence is off -If [persistence](../persistence/) is enabled, catalog additions will remain between runs. +If `--catalogInitial` is not specified, the default initial catalog at `brooklyn/default.catalog.bom` will be used. +As `scanJavaAnnotations: true` is set in `default.catalog.bom`, Brooklyn will scan the classpath for catalog items, +which will be added to the catalog. +To launch Brooklyn without initializing the catalog, use `--catalogInitial classpath://brooklyn/empty.catalog.bom` + +If [persistence](../persistence/) is enabled, catalog additions will remain between runs. If items that were +previously added based on items in `brooklyn/default.catalog.bom` or `--catalogInitial` are +deleted, they will not be re-added on subsequent restarts of brooklyn. I.e. `--catalogInitial` is ignored +if persistence is enabled and persistent state has already been created. + For more information on these commands, run `brooklyn help launch`.
