Skip to content

cli reference overview base cmd - #5010

Merged
dvdksn merged 8 commits into
docker:masterfrom
dvdksn:cli-reference-overview-base-cmd
Jul 5, 2024
Merged

cli reference overview base cmd#5010
dvdksn merged 8 commits into
docker:masterfrom
dvdksn:cli-reference-overview-base-cmd

Conversation

@dvdksn

@dvdksndvdksn commented Apr 12, 2024

Copy link
Copy Markdown
Contributor

- What I did

Moves the cli.md file to become the docker.md base command reference.

This file contains a lot of information about how the CLI and its flags work, base flags, configuration file, and environment variables. I think it makes more sense to have it on the base command page than in a separate place.

Needs:

- How I did it

- How to verify it

- Description for the changelog

- A picture of a cute animal (not mandatory but encouraged)

@codecov-commenter

codecov-commenter commented Apr 12, 2024

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.48%. Comparing base (1dee86b) to head (dc22572).

Additional details and impacted files
@@ Coverage Diff @@## master #5010 +/- ##
=======================================
Coverage 61.48% 61.48% =======================================
Files 298 298 Lines 20814 20814 =======================================
Hits 12797 12797 Misses 7105 7105 Partials 912 912 

@dvdksn
dvdksn marked this pull request as ready for review April 12, 2024 13:52
@dvdksn
dvdksn requested a review from thaJeztah as a code ownerApril 12, 2024 13:52
Comment threaddocs/reference/commandline/cli.md
@dvdksn
dvdksnforce-pushed the cli-reference-overview-base-cmd branch from 81ae886 to c220581CompareMay 27, 2024 12:35
@dvdksn
dvdksnforce-pushed the cli-reference-overview-base-cmd branch from c220581 to 719f88eCompareJuly 2, 2024 13:22
@dvdksn
dvdksn requested a review from a team as a code ownerJuly 2, 2024 13:22
@dvdksn
dvdksnforce-pushed the cli-reference-overview-base-cmd branch from 719f88e to eca29b5CompareJuly 3, 2024 06:30
@dvdksn
dvdksn requested a review from thaJeztahJuly 3, 2024 06:31
@dvdksn
dvdksnforce-pushed the cli-reference-overview-base-cmd branch from eca29b5 to 218fbf8CompareJuly 3, 2024 06:34

@thaJeztahthaJeztah left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

Comment threaddocs/reference/commandline/docker.md Outdated
Comment on lines +91 to +178
You can specify options like `-a=[]` multiple times in a single command line,
for example in these commands:

```console
$ docker run -a stdin -a stdout -i -t ubuntu /bin/bash

$ docker run -a stdin -a stdout -a stderr ubuntu /bin/ls

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not for this PR, but we need to look at some of these; -a / --attach is shown as list, and those can take multiple values, but for other flags, Cobra is good at silently ignoring duplicates, and in that case overriding previous values. (e.g. -i -i=false -i=true -i)

Also for a follow-up, we should pick a different example than -a, as it's really more of an "expert" use-case to set that. Perhaps something like -e / --env or something common could be a good one to pick as example (the --env one can be nice as we could show the result;

$ docker run --rm -e ENV_ONE=one -e ENV_TWO=two alpine printenv
ENV_ONE=one
ENV_TWO=two
<...>```.

@thaJeztahthaJeztah added this to the 28.0.0 milestone Jul 3, 2024
dvdksn added 8 commits July 4, 2024 10:28
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
@dvdksn
dvdksnforce-pushed the cli-reference-overview-base-cmd branch from 218fbf8 to dc22572CompareJuly 4, 2024 08:31
@dvdksn
dvdksn merged commit 9bb1a62 into docker:masterJul 5, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@dvdksn@codecov-commenter@thaJeztah