README.md: update supported flags table #791
Conversation
| | **--target-arch** | [Target arch](#-target-architecture) to build | ❌ | | ||
| | **--verbose** | Switch output/progress to verbose mode | `false` | | ||
| | --tls-verify | Require HTTPS and verify certificates when contacting registries | `true` | | ||
| | **--type** | [Image type](#-image-types) to build (can be passed multiple times) | `qcow2` | |
There was a problem hiding this comment.
There's a mix of information on how --type should be passed in. One place says it can be passed in multiple times (--type qcow2 --type raw), and another says to use a string array (--type [qcow2,raw]).
Even if both are supported, I think it would be good to standardise on which is recommended in the docs to avoid confusion. Or mentioning both in the same sentence/section, saying "both are supported".
There was a problem hiding this comment.
I updated the README to clarify this a bit more, part of the issue is the language from cobra, it auto-generates the "stringArray" word. I would have to look into cobra to see how to workaround/replace this if it's too confusing.
There was a problem hiding this comment.
Let's start here and turn the above comment into an issue (I'll click the button).
README.md
Outdated
| --target-arch string build for the given target architecture (experimental) | ||
| --tls-verify require HTTPS and verify certificates when contacting registries (default true) | ||
| --type stringArray image types to build [ami, anaconda-iso, gce, iso, qcow2, raw, vhd, vmdk] (default [qcow2]) | ||
| --version version for build |
There was a problem hiding this comment.
| --version version for build | |
| --version version for bootc-image-builder |
"version for build" is slightly confusing because I'm not sure whether it's the version of my image build or the BIB image.
There was a problem hiding this comment.
Good catch, thank you! I fixed this now in the README. Fixing this in the code is a bit more work as we need to workaround cobra here.
This commit updates the documentation around the supported flags. It also switches on "bold" for a smaller subset of the important flags. Note that still not all flags are shows, some are documented below (like the `--aws-*`) and some (like --store, --rpmmd) require more context, i.e. explaining that they require calling podman with the right `--volume` mappings.
This commit updates the documentation around the supported flags. It also switches on "bold" for a smaller subset of the important flags.
Note that still not all flags are shows, some are documented below (like the
--aws-*) and some (like --store, --rpmmd) require more context, i.e. explaining that they require calling podman with the right--volumemappings.