From 75af18661f918a81e1d95ed3e5d365c5e9f7c369 Mon Sep 17 00:00:00 2001 From: Adrien Delorme Date: Fri, 11 Jan 2019 11:23:42 +0100 Subject: [PATCH] Document --except & --only flags for post-processors --- contrib/zsh-completion/_packer | 2 +- website/source/docs/commands/build.html.md | 15 ++++++++------- .../source/docs/templates/provisioners.html.md | 8 ++++---- 3 files changed, 13 insertions(+), 12 deletions(-) diff --git a/contrib/zsh-completion/_packer b/contrib/zsh-completion/_packer index 38df34236..f0ae47fd9 100644 --- a/contrib/zsh-completion/_packer +++ b/contrib/zsh-completion/_packer @@ -14,7 +14,7 @@ _packer () { '-force[Force a build to continue if artifacts exist, deletes existing artifacts.]' '-machine-readable[Produce machine-readable output.]' '-color=[(false) Disable color output. (Default: color)]' - '-except=[(foo,bar,baz) Build all builds other than these.]' + '-except=[(foo,bar,baz) Run all builds and post-procesors other than these.]' '-on-error=[(cleanup,abort,ask) If the build fails do: clean up (default), abort, or ask.]' '-only=[(foo,bar,baz) Only build the given builds by name.]' '-parallel=[(false) Disable parallelization. (Default: parallel)]' diff --git a/website/source/docs/commands/build.html.md b/website/source/docs/commands/build.html.md index 4788b1c12..131b22587 100644 --- a/website/source/docs/commands/build.html.md +++ b/website/source/docs/commands/build.html.md @@ -26,10 +26,10 @@ artifacts that are created will be outputted at the end of the build. will stop between each step, waiting for keyboard input before continuing. This will allow the user to inspect state and so on. -- `-except=foo,bar,baz` - Builds all the builds except those with the given - comma-separated names. Build names by default are the names of their - builders, unless a specific `name` attribute is specified within the - configuration. +- `-except=foo,bar,baz` - Run all the builds and post-processors except + those with the given comma-separated names. Build and post-processor names + by default are their type, unless a specific `name` attribute is specified + within the configuration. - `-force` - Forces a builder to run when artifacts from a previous build prevent a build from running. The exact behavior of a forced build is left @@ -44,9 +44,10 @@ artifacts that are created will be outputted at the end of the build. presents a prompt and waits for you to decide to clean up, abort, or retry the failed step. -- `-only=foo,bar,baz` - Only build the builds with the given comma-separated - names. Build names by default are the names of their builders, unless a - specific `name` attribute is specified within the configuration. +- `-only=foo,bar,baz` - Only run the builds and post-processors with the + given comma-separated names. Build and post-processor names by default are + their type, unless a specific `name` attribute is specified within the + configuration. - `-parallel=false` - Disable parallelization of multiple builders (on by default). diff --git a/website/source/docs/templates/provisioners.html.md b/website/source/docs/templates/provisioners.html.md index 1a13948c9..d4cd5e555 100644 --- a/website/source/docs/templates/provisioners.html.md +++ b/website/source/docs/templates/provisioners.html.md @@ -77,10 +77,10 @@ effectively the same: } ``` -The values within `only` or `except` are *build names*, not builder types. If -you recall, build names by default are just their builder type, but if you -specify a custom `name` parameter, then you should use that as the value -instead of the type. +The values within `only` or `except` can be *build or post-processor names*, +not builder types. If you recall, build and post-processor names by default are +just their builder type, but if you specify a custom `name` parameter, then you +should use that as the value instead of the type. ## Build-Specific Overrides