Document --except & --only flags for post-processors

This commit is contained in:
Adrien Delorme 2019-01-11 11:23:42 +01:00
parent 61ade0e127
commit 75af18661f
3 changed files with 13 additions and 12 deletions

View File

@ -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)]'

View File

@ -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).

View File

@ -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