mirror of
https://github.com/containers/podman.git
synced 2025-06-02 10:46:09 +08:00
c6090c290e
New functionality in hack/man-page-checker: start cross- referencing the man page 'Synopsis' line against the output of 'podman foo --help'. This is part 1, flag/option consistency. Part 2 (arg consistency) is too big and will have to wait for later. flag/option consistency means: if 'podman foo --help' includes the string '[flags]' in the Usage message, make sure the man page includes '[*options*]' in its Synopsis line, and vice-versa. This found several inconsistencies, which I've fixed. While doing this I realized that Cobra automatically includes a 'Flags:' subsection in its --help output for all subcommands that have defined flags. This is great - it lets us cross-check against the usage synopsis, and make sure that '[flags]' is present or absent as needed, without fear of human screwups. If a flag-less subcommand ever gets extended with flags, but the developer forgets to add '[flags]' and remove DisableFlagsInUseLine, we now have a test that will catch that. (This, too, caught two instances which I fixed). I don't actually know if the new man-page-checker functionality will work in CI: I vaguely recall that it might run before 'make podman' does; and also vaguely recall that some steps were taken to remedy that. Signed-off-by: Ed Santiago <santiago@redhat.com>
62 lines
2.0 KiB
Markdown
62 lines
2.0 KiB
Markdown
% podman-manifest-annotate(1)
|
|
|
|
## NAME
|
|
podman\-manifest\-annotate - Add or update information about an entry in a manifest list or image index
|
|
|
|
## SYNOPSIS
|
|
**podman manifest annotate** [*options*] *listnameorindexname* *imagemanifestdigest*
|
|
|
|
## DESCRIPTION
|
|
|
|
Adds or updates information about an image included in a manifest list or image index.
|
|
|
|
## OPTIONS
|
|
|
|
**--annotation** *annotation=value*
|
|
|
|
Set an annotation on the entry for the specified image.
|
|
|
|
**--arch**
|
|
|
|
Override the architecture which the list or index records as a requirement for
|
|
the image. This is usually automatically retrieved from the image's
|
|
configuration information, so it is rarely necessary to use this option.
|
|
|
|
|
|
**--features**
|
|
|
|
Specify the features list which the list or index records as requirements for
|
|
the image. This option is rarely used.
|
|
|
|
**--os**
|
|
|
|
Override the OS which the list or index records as a requirement for the image.
|
|
This is usually automatically retrieved from the image's configuration
|
|
information, so it is rarely necessary to use this option.
|
|
|
|
**--os-features**
|
|
|
|
Specify the OS features list which the list or index records as requirements
|
|
for the image. This option is rarely used.
|
|
|
|
**--os-version**
|
|
|
|
Specify the OS version which the list or index records as a requirement for the
|
|
image. This option is rarely used.
|
|
|
|
**--variant**
|
|
|
|
Specify the variant which the list or index records for the image. This option
|
|
is typically used to distinguish between multiple entries which share the same
|
|
architecture value, but which expect different versions of its instruction set.
|
|
|
|
## EXAMPLE
|
|
|
|
```
|
|
podman manifest annotate --arch arm64 --variant v8 mylist:v1.11 sha256:59eec8837a4d942cc19a52b8c09ea75121acc38114a2c68b98983ce9356b8610
|
|
07ec8dc22b5dba3a33c60b68bce28bbd2b905e383fdb32a90708fa5eeac13a07: sha256:59eec8837a4d942cc19a52b8c09ea75121acc38114a2c68b98983ce9356b8610
|
|
```
|
|
|
|
## SEE ALSO
|
|
podman(1), podman-manifest(1), podman-manifest-add(1), podman-manifest-create(1), podman-manifest-inspect(1), podman-rmi(1)
|