aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2021-07-08 04:48:10 -0400
committerGitHub <noreply@github.com>2021-07-08 04:48:10 -0400
commit275b0d82636474b0a3c631e63d0da2c2575b7987 (patch)
treebc499a64511f8559ee45be1da172779ff4cb7821
parent6f0bf16c83bcd71c31028a12e4a414cc41d02553 (diff)
parent75431a455f4d4a68ed001206f963088d526a2aef (diff)
downloadpodman-275b0d82636474b0a3c631e63d0da2c2575b7987.tar.gz
podman-275b0d82636474b0a3c631e63d0da2c2575b7987.tar.bz2
podman-275b0d82636474b0a3c631e63d0da2c2575b7987.zip
Merge pull request #10869 from vrothberg/3.2-backports
[CI:DOCS] [3.2] podman search: clarify that results depend on implementation
-rw-r--r--docs/source/markdown/podman-search.1.md11
1 files changed, 8 insertions, 3 deletions
diff --git a/docs/source/markdown/podman-search.1.md b/docs/source/markdown/podman-search.1.md
index ec610d3ba..661ad6742 100644
--- a/docs/source/markdown/podman-search.1.md
+++ b/docs/source/markdown/podman-search.1.md
@@ -9,13 +9,18 @@ podman\-search - Search a registry for an image
## DESCRIPTION
**podman search** searches a registry or a list of registries for a matching image.
The user can specify which registry to search by prefixing the registry in the search term
-(example **registry.fedoraproject.org/fedora**), default is the registries in the
-**registries.search** table in the config file - **/etc/containers/registries.conf**.
+(e.g., **registry.fedoraproject.org/fedora**). By default, all
+unqualified-search registries in `containers-registries.conf(5)` are used.
+
The default number of results is 25. The number of results can be limited using the **--limit** flag.
If more than one registry is being searched, the limit will be applied to each registry. The output can be filtered
using the **--filter** flag. To get all available images in a registry without a specific
search term, the user can just enter the registry name with a trailing "/" (example **registry.fedoraproject.org/**).
-Note, searching without a search term will only work for registries that implement the v2 API.
+
+Note that **podman search** is not a reliable way to determine the presence or existence of an image.
+The search behavior of the v1 and v2 Docker distribution API is specific to the implementation of each registry.
+Some registries may not support searching at all.
+Further note that searching without a search term will only work for registries that implement the v2 API.
**podman [GLOBAL OPTIONS]**