root
/
buildah
mirror of https://github.com/containers/buildah.git
1
0
Fork 0
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Touch up os/arch doc 

Touching up the OS, ARCH and PLATFORM options
doc just a bit from #2907.

Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>

Closes: #2101
Approved by: rhatdan
This commit is contained in:
TomSweeneyRedHat 2020-01-21 11:09:59 -05:00 committed by Atomic Bot
parent 1033abccb7
commit 82ff48a066
2 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/buildah-bud.md
View File

@ -44,7 +44,7 @@ Note: this information is not present in Docker image formats, so it is discarde
**--arch**="ARCH"
Set the ARCH instead of the architecture of the current machine in the image manifest and config.
Set the ARCH of the image to the provided value instead of using the architecture of the host.
**--authfile** *path*
@ -333,7 +333,7 @@ Do not use existing cached images for the container build. Build from the start
**--os**="OS"
Set the OS instead of the current operating system of the machine in the image manifest and config.
Set the OS of the image to the provided value instead of using the current operating system of the host.
**--pid** *how*
@ -346,9 +346,10 @@ process.
**--platform**="OS/ARCH"
Set the OS/ARCH instead of the current operating system and architecture of the
machine in the image manifest and config (for example `linux/arm`). If
`--platform` is set, then the values of `--arch` and `--os` will be overwritten.
Set the OS/ARCH of the image to the provided value instead of using the current
operating system and architecture of the host (for example `linux/arm`). If
`--platform` is set, then the values of the `--arch` and `--os` options will be
overridden.
**--pull**

6
pkg/cli/common.go
View File

@ -148,7 +148,7 @@ func GetLayerFlags(flags *LayerResults) pflag.FlagSet {
// GetBudFlags returns common bud flags
func GetBudFlags(flags *BudResults) pflag.FlagSet {
fs := pflag.FlagSet{}
fs.StringVar(&flags.Arch, "arch", runtime.GOARCH, "set the ARCH instead of the architecture of the current machine in the image manifest and config")
fs.StringVar(&flags.Arch, "arch", runtime.GOARCH, "set the ARCH of the image to the provided value instead of the architecture of the host")
fs.StringArrayVar(&flags.Annotation, "annotation", []string{}, "Set metadata for an image (default [])")
fs.StringVar(&flags.Authfile, "authfile", GetDefaultAuthFile(), "path of the authentication file.")
fs.StringArrayVar(&flags.BuildArg, "build-arg", []string{}, "`argument=value` to supply to the builder")
@ -165,8 +165,8 @@ func GetBudFlags(flags *BudResults) pflag.FlagSet {
fs.BoolVar(&flags.NoCache, "no-cache", false, "Do not use existing cached images for the container build. Build from the start with a new set of cached layers.")
fs.StringVar(&flags.Logfile, "logfile", "", "log to `file` instead of stdout/stderr")
fs.IntVar(&flags.Loglevel, "loglevel", 0, "adjust logging level (range from -2 to 3)")
fs.StringVar(&flags.OS, "os", runtime.GOOS, "set the OS instead of the current operating system of the machine in the image manifest and config")
fs.StringVar(&flags.Platform, "platform", parse.DefaultPlatform(), "set the OS/ARCH instead of the current operating system and architecture of the machine in the image manifest and config (for example `linux/arm`)")
fs.StringVar(&flags.OS, "os", runtime.GOOS, "set the OS to the provided value instead of the current operating system of the host")
fs.StringVar(&flags.Platform, "platform", parse.DefaultPlatform(), "set the OS/ARCH to the provided value instead of the current operating system and architecture of the host (for example `linux/arm`)")
fs.BoolVar(&flags.Pull, "pull", true, "pull the image from the registry if newer or not present in store, if false, only pull the image if not present")
fs.BoolVar(&flags.PullAlways, "pull-always", false, "pull the image even if the named image is present in store")
fs.BoolVar(&flags.PullNever, "pull-never", false, "do not pull the image, use the image present in store if available")