Skip to content

Commit

Permalink
README.md: document --progress better
Browse files Browse the repository at this point in the history
This commit adds the missing documentation for `--progress` in the
README. Not having this lead to some confusion, e.g. in questions
in osbuild#765 that
a better README would have avoided. Hopefully this answers the
questions :)
  • Loading branch information
mvo5 committed Jan 7, 2025
1 parent 4545246 commit d29e872
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ Usage:
Flags:
--chown string chown the ouput directory to match the specified UID:GID
--tls-verify require HTTPS and verify certificates when contacting registries (default true)
--progress string type of progress bar to use (e.g. plain,term)
--type string image type to build [qcow2, ami] (default "qcow2")
--target-arch string architecture to build image for (default is the native architecture)
```
Expand All @@ -137,6 +138,7 @@ Flags:
| Argument | Description | Default Value |
|-------------------|-----------------------------------------------------------------------------------------------------------|:-------------:|
| **--chown** | chown the output directory to match the specified UID:GID ||
| **--progress** | Show progress in the given format, supported: plain,term,debug. If empty it is auto-detected ||
| **--rootfs** | Root filesystem type. Overrides the default from the source container. Supported values: ext4, xfs, btrfs ||
| **--tls-verify** | Require HTTPS and verify certificates when contacting registries | `true` |
| **--type** | [Image type](#-image-types) to build | `qcow2` |
Expand Down Expand Up @@ -172,6 +174,16 @@ a non-native architecture bootc OCI image, say, building for x86_64 from an arm-
`podman build` with the `--platform linux/amd64` flag. In this case, to then build a disk image from the same arm-based Mac,
you should provide `--target-arch amd64` when running the `bootc-image-builder` command.

## Progress types

The following progress types are supported:

* plain: No spinners or progress bar, just information and full osbuild output
* term: Terminal based output, spinner, progressbar and most details of osbuild are hidden
* debug: Details how the progress is called, mostly useful for bugreports

Note that when no value is given the progress is auto-detected baed on the environment. When `stdin` is a terminal the "term" progress is used, otherwise "plain". The output of `plain` is exactaly the same as it was before progress reporting was implemented.

## ☁️ Cloud uploaders

### Amazon Machine Images (AMIs)
Expand Down

0 comments on commit d29e872

Please sign in to comment.