docker / docker/cli

missing definition of 'list'

Open
#2,138 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

area/ux kind/docs
Dominant language
Go
Stars
6.1k
Forks
2.2k
Avg merge
1d 15h
Merged PRs (30d)
43

Description

docker run --help etc. mentions several times list as an option argument but does not define, what a list actually is. E.g.:

      --dns list                       Set custom DNS servers
      --dns-option list                Set DNS options
      --dns-search list                Set custom DNS search domains

I've tried e.g. --dns '1.2.3.4,5.6.7.8' but this does not work and results into

invalid argument "1.2.3.4,5.6.7.8" for "--dns" flag: 1.2.3.4,5.6.7.8 is not an ip address
See 'docker run --help'.

Also the man page is wrong: It shows e.g.

--dns=[]  Set custom DNS servers

[] denotes optional arguments in man pages. Since it does not contain any argument, it is actually the same as --dns (does not allow any argument).

So it should be documented/defined, what a list is/what docker actually expects as argument.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by running docker run --help and reviewing the generated man-page output for --dns, --dns-option, and --dns-search. Trace where these option descriptions are defined and how their arguments are parsed. Done means the help text and man page consistently define the expected list syntax and no longer show misleading empty brackets.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, go
Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.