opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-06-24 03:08:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #20015 from edsantiago/xref_filter_no_asterisks

Browse Source 
[CI:DOCS] consistentize filter options in man pages
This commit is contained in:
OpenShift Merge Robot
2023-09-18 16:25:29 +02:00
committed by GitHub
parent d912e735a3 a80a908df7
commit d41047c1cf
8 changed files with 56 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/source/markdown/podman-container-prune.1.md
View File

@ -18,10 +18,10 @@ The *filters* argument format is of `key=value`. If there is more than one *filt
Supported filters: Supported filters:
| Filter | Description | | Filter | Description |
| :----------------: | --------------------------------------------------------------------------- | |:------:|------------------------------------------------------------------------------------------------------|
| *label* | Only remove containers, with (or without, in the case of label!=[...] is used) the specified labels. | | label | Only remove containers, with (or without, in the case of label!=[...] is used) the specified labels. |
| *until* | Only remove containers created before given timestamp. | | until | Only remove containers created before given timestamp. |
The `label` *filter* accepts two formats. One is the `label`=*key* or `label`=*key*=*value*, which removes containers with the specified labels. The other format is the `label!`=*key* or `label!`=*key*=*value*, which removes containers without the specified labels. The `label` *filter* accepts two formats. One is the `label`=*key* or `label`=*key*=*value*, which removes containers with the specified labels. The other format is the `label!`=*key* or `label!`=*key*=*value*, which removes containers without the specified labels.

8
docs/source/markdown/podman-image-prune.1.md
View File

@ -29,10 +29,10 @@ The *filters* argument format is of `key=value`. If there is more than one *filt
Supported filters: Supported filters:
| Filter | Description | | Filter | Description |
| :----------------: | --------------------------------------------------------------------------- | |:------:|--------------------------------------------------------------------------------------------------|
| *label* | Only remove images, with (or without, in the case of label!=[...] is used) the specified labels. | | label | Only remove images, with (or without, in the case of label!=[...] is used) the specified labels. |
| *until* | Only remove images created before given timestamp. | | until | Only remove images created before given timestamp. |
The `label` *filter* accepts two formats. One is the `label`=*key* or `label`=*key*=*value*, which removes containers with the specified labels. The other format is the `label!`=*key* or `label!`=*key*=*value*, which removes containers without the specified labels. The `label` *filter* accepts two formats. One is the `label`=*key* or `label`=*key*=*value*, which removes containers with the specified labels. The other format is the `label!`=*key* or `label!`=*key*=*value*, which removes containers without the specified labels.

28
docs/source/markdown/podman-images.1.md.in
View File

@ -31,20 +31,20 @@ The *filters* argument format is of `key=value` or `key!=value`. If there is mor
Supported filters: Supported filters:
| Filter | Description | | Filter | Description |
|:---------------:|-----------------------------------------------------------------------------------------------| |:------------:|-----------------------------------------------------------------------------------------------|
| *id* | Filter by image ID. | | id | Filter by image ID. |
| *before* | Filter by images created before the given IMAGE (name or tag). | | before | Filter by images created before the given IMAGE (name or tag). |
| *containers* | Filter by images with a running container. | | containers | Filter by images with a running container. |
| *dangling* | Filter by dangling (unused) images. | | dangling | Filter by dangling (unused) images. |
| *digest* | Filter by digest. | | digest | Filter by digest. |
| *intermediate* | Filter by images that are dangling and have no children | | intermediate | Filter by images that are dangling and have no children |
| *label* | Filter by images with (or without, in the case of label!=[...] is used) the specified labels. | | label | Filter by images with (or without, in the case of label!=[...] is used) the specified labels. |
| *manifest* | Filter by images that are manifest lists. | | manifest | Filter by images that are manifest lists. |
| *readonly* | Filter by read-only or read/write images. | | readonly | Filter by read-only or read/write images. |
| *reference* | Filter by image name. | | reference | Filter by image name. |
| *after*/*since* | Filter by images created after the given IMAGE (name or tag). | | after/since | Filter by images created after the given IMAGE (name or tag). |
| *until* | Filter by images created until the given duration or time. | | until | Filter by images created until the given duration or time. |
The `id` *filter* accepts the image ID string. The `id` *filter* accepts the image ID string.

8
docs/source/markdown/podman-network-prune.1.md
View File

@ -21,10 +21,10 @@ The *filters* argument format is of `key=value`. If there is more than one *filt
Supported filters: Supported filters:
| Filter | Description | | Filter | Description |
| :----------------: | --------------------------------------------------------------------------- | |:------:|----------------------------------------------------------------------------------------------------|
| *label* | Only remove networks, with (or without, in the case of label!=[...] is used) the specified labels. | | label | Only remove networks, with (or without, in the case of label!=[...] is used) the specified labels. |
| *until* | Only remove networks created before given timestamp. | | until | Only remove networks created before given timestamp. |
The `label` *filter* accepts two formats. One is the `label`=*key* or `label`=*key*=*value*, which removes networks with the specified labels. The other format is the `label!`=*key* or `label!`=*key*=*value*, which removes networks without the specified labels. The `label` *filter* accepts two formats. One is the `label`=*key* or `label`=*key*=*value*, which removes networks with the specified labels. The other format is the `label!`=*key* or `label!`=*key*=*value*, which removes networks without the specified labels.

24
docs/source/markdown/podman-pod-ps.1.md.in
View File

@ -48,18 +48,18 @@ The *filters* argument format is of `key=value`. If there is more than one *filt
Supported filters: Supported filters:
| Filter | Description | | Filter | Description |
|--------------|--------------------------------------------------------------------------------------------------| |------------|--------------------------------------------------------------------------------------------------|
| *ctr-ids* | Filter by container ID within the pod. (CID prefix match by default; accepts regex) | | ctr-ids | Filter by container ID within the pod. (CID prefix match by default; accepts regex) |
| *ctr-names* | Filter by container name within the pod. | | ctr-names | Filter by container name within the pod. |
| *ctr-number* | Filter by number of containers in the pod. | | ctr-number | Filter by number of containers in the pod. |
| *ctr-status* | Filter by container status within the pod. | | ctr-status | Filter by container status within the pod. |
| *id* | Filter by pod ID. (Prefix match by default; accepts regex) | | id | Filter by pod ID. (Prefix match by default; accepts regex) |
| *label* | Filter by container with (or without, in the case of label!=[...] is used) the specified labels. | | label | Filter by container with (or without, in the case of label!=[...] is used) the specified labels. |
| *name* | Filter by pod name. | | name | Filter by pod name. |
| *network* | Filter by network name or full ID of network. | | network | Filter by network name or full ID of network. |
| *status* | Filter by pod status. | | status | Filter by pod status. |
| *until* | Filter by pods created before given timestamp. | | until | Filter by pods created before given timestamp. |
The `ctr-ids`, `ctr-names`, `id`, `name` filters accept `regex` format. The `ctr-ids`, `ctr-names`, `id`, `name` filters accept `regex` format.

8
docs/source/markdown/podman-system-prune.1.md
View File

@ -34,10 +34,10 @@ The *filters* argument format is of `key=value`. If there is more than one *filt
Supported filters: Supported filters:
| Filter | Description | | Filter | Description |
| :----------------: | --------------------------------------------------------------------------- | |:------:|-----------------------------------------------------------------------------------------------------------------|
| *label* | Only remove containers and images, with (or without, in the case of label!=[...] is used) the specified labels. | | label | Only remove containers and images, with (or without, in the case of label!=[...] is used) the specified labels. |
| *until* | Only remove containers and images created before given timestamp. | | until | Only remove containers and images created before given timestamp. |
The `label` *filter* accepts two formats. One is the `label`=*key* or `label`=*key*=*value*, which removes containers and images with the specified labels. The other format is the `label!`=*key* or `label!`=*key*=*value*, which removes containers and images without the specified labels. The `label` *filter* accepts two formats. One is the `label`=*key* or `label`=*key*=*value*, which removes containers and images with the specified labels. The other format is the `label!`=*key* or `label!`=*key*=*value*, which removes containers and images without the specified labels.

20
docs/source/markdown/podman-volume-prune.1.md
View File

@ -23,16 +23,16 @@ The *filters* argument format is of `key=value`. If there is more than one *filt
Supported filters: Supported filters:
| Filter | Description | | Filter | Description |
|:-------------:|------------------------------------------------------------------------------------------------------------| |:-----------:|------------------------------------------------------------------------------------------------------------|
| *dangling* | [Bool] Only remove volumes not referenced by any containers | | dangling | [Bool] Only remove volumes not referenced by any containers |
| *driver* | [String] Only remove volumes with the given driver | | driver | [String] Only remove volumes with the given driver |
| *label* | [String] Only remove volumes, with (or without, in the case of label!=[...] is used) the specified labels. | | label | [String] Only remove volumes, with (or without, in the case of label!=[...] is used) the specified labels. |
| *name* | [String] Only remove volume with the given name | | name | [String] Only remove volume with the given name |
| *opt* | [String] Only remove volumes created with the given options | | opt | [String] Only remove volumes created with the given options |
| *scope* | [String] Only remove volumes with the given scope | | scope | [String] Only remove volumes with the given scope |
| *until* | [DateTime] Only remove volumes created before given timestamp. | | until | [DateTime] Only remove volumes created before given timestamp. |
| *after/since* | [Volume] Filter by volumes created after the given VOLUME (name or tag) | | after/since | [Volume] Filter by volumes created after the given VOLUME (name or tag) |
The `label` *filter* accepts two formats. One is the `label`=*key* or `label`=*key*=*value*, which removes volumes with the specified labels. The other format is the `label!`=*key* or `label!`=*key*=*value*, which removes volumes without the specified labels. The `label` *filter* accepts two formats. One is the `label`=*key* or `label`=*key*=*value*, which removes volumes with the specified labels. The other format is the `label!`=*key* or `label!`=*key*=*value*, which removes volumes without the specified labels.

12
hack/xref-helpmsgs-manpages
View File

@ -670,17 +670,13 @@ sub podman_man {
if ($line =~ /^\|\s+(\S+)\s+\|/) { if ($line =~ /^\|\s+(\S+)\s+\|/) {
my $filter = $1; my $filter = $1;
# Special-case transformation: some man pages use
# asterisks, "*foo*", some don't. Ignore asterisks.
$filter =~ tr/\*//d;
# (Garbage: these are just table column titles & dividers) # (Garbage: these are just table column titles & dividers)
next LINE if $filter eq 'Filter'; next LINE if $filter =~ /^\**Filter\**$/;
next LINE if $filter =~ /---+/; next LINE if $filter =~ /---+/;
# Another special case: treat slash-separated options # Special case: treat slash-separated options
# ("after/since") as identical, and require that each # ("after/since") as identical, and require that
# be documented. # each be documented.
for my $f (split '/', $filter) { for my $f (split '/', $filter) {
# Special case for negated options ("label!="): allow, # Special case for negated options ("label!="): allow,
# but only immediately after the positive case. # but only immediately after the positive case.