From c65513b37d4c956cea95b56bc45d1bfdf093233c Mon Sep 17 00:00:00 2001 From: lilydjwg Date: Sun, 23 May 2021 17:37:35 +0800 Subject: [PATCH] doc: clarify options of the container source See also: https://github.com/lilydjwg/nvchecker/issues/183 --- docs/usage.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/usage.rst b/docs/usage.rst index f0af5dc..2e1430c 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -721,6 +721,22 @@ container registry The container registry host. Default: ``docker.io`` +``registry`` and ``container`` are the host and the path used in the pull +command. Note that the ``docker`` command allows omitting some parts of the +container name while this plugin requires the full name. If the host part is +omitted, use ``docker.io``, and if there is no slash in the path, prepend +``library/`` to the path. Here are some examples: + ++----------------------------------------------+-----------+--------------------------+ +| Pull command | registry | container | ++==============================================+===========+==========================+ +| docker pull quay.io/prometheus/node-exporter | quay.io | prometheus/node-exporter | ++----------------------------------------------+-----------+--------------------------+ +| docker pull nvidia/cuda | docker.io | nvidia/cuda | ++----------------------------------------------+-----------+--------------------------+ +| docker pull python | docker.io | library/python | ++----------------------------------------------+-----------+--------------------------+ + This source returns tags and supports :ref:`list options`. Check ALPM database