Skip to content

Update a few flag help strings for consistency and clarity #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
vieux merged 1 commit into from
Nov 21, 2013
Merged

Update a few flag help strings for consistency and clarity #63

vieux merged 1 commit into from
Nov 21, 2013

Conversation

@tianon
Copy link

@tianon tianon commented Nov 21, 2013

While looking at the help for -graph-driver (-graph-driver="": For docker to use a specific graph driver) and realizing that it was probably supposed to be "Force", I noticed that our flag help strings were a little inconsistent in a few places (both in verbiage and in punctuation - some with periods, some without). I'm still not 100% happy with what I came up with for -H after iterating through quite a few different wordings there, but at least it's more clear than what we've got now.

Some wordings, like the help text for -iptables were additionally misleading. "Disable iptables within docker" could easily be misinterpreted to mean that docker would force disable existing iptables rules, which isn't a feeling we want to even hint at, because we're actually really, really careful not to break anything that already exists. :)

Here's the full before and after output:

$ docker -h # before
  -D=false: Debug mode
  -H=[unix:///var/run/docker.sock]: tcp://host:port to bind/connect to or unix://path/to/socket to use
  -api-enable-cors=false: Enable CORS requests in the remote api.
  -b="": Attach containers to a pre-existing network bridge. Use 'none' to disable container networking
  -d=false: Daemon mode
  -dns="": Set custom dns servers
  -g="/var/lib/docker": Path to use as the root of the docker runtime.
  -graph-driver="": For docker to use a specific graph driver
  -icc=true: Enable inter-container communication
  -ip="0.0.0.0": Default ip address to use when binding a containers ports
  -iptables=true: Disable iptables within docker
  -p="/var/run/docker.pid": File containing process PID
  -r=true: Restart previously running containers
  -v=false: Print version information and quit

$ docker -h # after
  -D=false: Enable debug mode
  -H=[unix:///var/run/docker.sock]: Multiple tcp://host:port or unix://path/to/socket to bind in daemon mode, single connection otherwise
  -api-enable-cors=false: Enable CORS headers in the remote API
  -b="": Attach containers to a pre-existing network bridge; use 'none' to disable container networking
  -d=false: Eanble daemon mode
  -dns="": Force docker to use specific DNS servers
  -g="/var/lib/docker": Path to use as the root of the docker runtime
  -graph-driver="": Force docker runtime to use a specific graph driver
  -icc=true: Enable inter-container communication
  -ip="0.0.0.0": Default IP address to use when binding container ports
  -iptables=true: Disable docker's addition of iptables rules
  -p="/var/run/docker.pid": Path to use for daemon PID file
  -r=true: Restart previously running containers
  -v=false: Print version information and quit

Of course, I'll be happy to update this more if anyone has better suggestions for wording. :)

@crosbymichael
Copy link

crosbymichael commented Nov 21, 2013

LGTM

vieux
vieux reviewed Nov 21, 2013
View reviewed changes
docker/docker.go Outdated
Copy link

@vieux vieux Nov 21, 2013

Choose a reason for hiding this comment

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

Typo "Eanble"

Copy link
Author

@tianon tianon Nov 21, 2013

Choose a reason for hiding this comment

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

Doh! Thanks. "How embarrassing." Fix pushed.

@vieux
Copy link

vieux commented Nov 21, 2013

LGTM

vieux pushed a commit that referenced this pull request Nov 21, 2013
Merge pull request #63 from tianon/flag-help-consistency
da824b4 
Update a few flag help strings for consistency and clarity
@vieux vieux merged commit da824b4 into shykes:0.6.5-dm-plugin Nov 21, 2013
@tianon tianon deleted the flag-help-consistency branch November 21, 2013 19:31
@tianon tianon mentioned this pull request Nov 25, 2013
Merged
shykes pushed a commit that referenced this pull request Apr 30, 2014
@crosbymichael
Merge pull request #63 from crosbymichael/bugs
3ab5a67 
Use issues as pointer
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@tianon @crosbymichael @vieux