From 566d3cb58b557df8ea6962653c43ba3fe995110f Mon Sep 17 00:00:00 2001 From: Mike McQuaid Date: Sun, 2 Apr 2017 10:14:21 +0100 Subject: Document all short flags. --- Library/Homebrew/cmd/fetch.rb | 4 ++-- Library/Homebrew/cmd/install.rb | 13 +++++++------ Library/Homebrew/cmd/link.rb | 2 +- Library/Homebrew/cmd/migrate.rb | 2 +- Library/Homebrew/cmd/outdated.rb | 2 +- Library/Homebrew/cmd/uninstall.rb | 2 +- Library/Homebrew/cmd/unpack.rb | 2 +- Library/Homebrew/cmd/update.sh | 2 +- Library/Homebrew/dev-cmd/bottle.rb | 2 +- Library/Homebrew/dev-cmd/test.rb | 2 +- Library/Homebrew/dev-cmd/tests.rb | 2 +- 11 files changed, 18 insertions(+), 17 deletions(-) (limited to 'Library') diff --git a/Library/Homebrew/cmd/fetch.rb b/Library/Homebrew/cmd/fetch.rb index 820a27e31..006c63746 100644 --- a/Library/Homebrew/cmd/fetch.rb +++ b/Library/Homebrew/cmd/fetch.rb @@ -8,14 +8,14 @@ #: If `-v` is passed, do a verbose VCS checkout, if the URL represents a VCS. #: This is useful for seeing if an existing VCS cache has been updated. #: -#: If `--force` is passed, remove a previously cached version and re-fetch. +#: If `--force` (or `-f`) is passed, remove a previously cached version and re-fetch. #: #: If `--retry` is passed, retry if a download fails or re-download if the #: checksum of a previously cached version no longer matches. #: #: If `--deps` is passed, also download dependencies for any listed . #: -#: If `--build-from-source` is passed, download the source rather than a +#: If `--build-from-source` (or `-s`) is passed, download the source rather than a #: bottle. #: #: If `--force-bottle` is passed, download a bottle if it exists for the diff --git a/Library/Homebrew/cmd/install.rb b/Library/Homebrew/cmd/install.rb index a113bde38..a32f2ef34 100644 --- a/Library/Homebrew/cmd/install.rb +++ b/Library/Homebrew/cmd/install.rb @@ -4,7 +4,7 @@ #: is usually the name of the formula to install, but it can be specified #: in several different ways. See [SPECIFYING FORMULAE][]. #: -#: If `--debug` is passed and brewing fails, open an interactive debugging +#: If `--debug` (or `-d`) is passed and brewing fails, open an interactive debugging #: session with access to IRB or a shell inside the temporary build directory. #: #: If `--env=std` is passed, use the standard build environment instead of superenv. @@ -24,7 +24,7 @@ #: `gcc-4.2` for Apple's GCC 4.2, or `gcc-4.9` for a Homebrew-provided GCC #: 4.9. #: -#: If `--build-from-source` or `-s` is passed, compile the specified from +#: If `--build-from-source` (or `-s`) is passed, compile the specified from #: source even if a bottle is provided. Dependencies will still be installed #: from bottles if they are available. #: @@ -48,11 +48,12 @@ #: during installation. #: #: * `install` `--interactive` [`--git`] : -#: Download and patch , then open a shell. This allows the user to -#: run `./configure --help` and otherwise determine how to turn the software -#: package into a Homebrew formula. +#: If `--interactive` (or `-i`) is passed, download and patch , then +#: open a shell. This allows the user to run `./configure --help` and +#: otherwise determine how to turn the software package into a Homebrew +#: formula. #: -#: If `--git` is passed, Homebrew will create a Git repository, useful for +#: If `--git` (or `-g`) is passed, Homebrew will create a Git repository, useful for #: creating patches to the software. require "missing_formula" diff --git a/Library/Homebrew/cmd/link.rb b/Library/Homebrew/cmd/link.rb index a1d1397da..5ce6bea48 100644 --- a/Library/Homebrew/cmd/link.rb +++ b/Library/Homebrew/cmd/link.rb @@ -10,7 +10,7 @@ #: be linked or which would be deleted by `brew link --overwrite`, but will not #: actually link or delete any files. #: -#: If `--force` is passed, Homebrew will allow keg-only formulae to be linked. +#: If `--force` (or `-f`) is passed, Homebrew will allow keg-only formulae to be linked. require "ostruct" diff --git a/Library/Homebrew/cmd/migrate.rb b/Library/Homebrew/cmd/migrate.rb index 2726b1480..951a2942e 100644 --- a/Library/Homebrew/cmd/migrate.rb +++ b/Library/Homebrew/cmd/migrate.rb @@ -2,7 +2,7 @@ #: Migrate renamed packages to new name, where are old names of #: packages. #: -#: If `--force` is passed, then treat installed and passed +#: If `--force` (or `-f`) is passed, then treat installed and passed #: like if they are from same taps and migrate them anyway. require "migrator" diff --git a/Library/Homebrew/cmd/outdated.rb b/Library/Homebrew/cmd/outdated.rb index e94002989..f163212e1 100644 --- a/Library/Homebrew/cmd/outdated.rb +++ b/Library/Homebrew/cmd/outdated.rb @@ -7,7 +7,7 @@ #: If `--quiet` is passed, list only the names of outdated brews (takes #: precedence over `--verbose`). #: -#: If `--verbose` is passed, display detailed version information. +#: If `--verbose` (or `-v`) is passed, display detailed version information. #: #: If `--json=` is passed, the output will be in JSON format. The only #: valid version is `v1`. diff --git a/Library/Homebrew/cmd/uninstall.rb b/Library/Homebrew/cmd/uninstall.rb index 5d02ebd1e..9c51a0d1c 100644 --- a/Library/Homebrew/cmd/uninstall.rb +++ b/Library/Homebrew/cmd/uninstall.rb @@ -1,7 +1,7 @@ #: * `uninstall`, `rm`, `remove` [`--force`] [`--ignore-dependencies`] : #: Uninstall . #: -#: If `--force` is passed, and there are multiple versions of +#: If `--force` (or `-f`) is passed, and there are multiple versions of #: installed, delete all installed versions. #: #: If `--ignore-dependencies` is passed, uninstalling won't fail, even if diff --git a/Library/Homebrew/cmd/unpack.rb b/Library/Homebrew/cmd/unpack.rb index 60d796d9f..89992e1f0 100644 --- a/Library/Homebrew/cmd/unpack.rb +++ b/Library/Homebrew/cmd/unpack.rb @@ -6,7 +6,7 @@ #: If `--patch` is passed, patches for will be applied to the #: unpacked source. #: -#: If `--git` is passed, a Git repository will be initialized in the unpacked +#: If `--git` (or `-g`) is passed, a Git repository will be initialized in the unpacked #: source. This is useful for creating patches for the software. require "stringio" diff --git a/Library/Homebrew/cmd/update.sh b/Library/Homebrew/cmd/update.sh index 5cfdb3f46..197a99f2e 100644 --- a/Library/Homebrew/cmd/update.sh +++ b/Library/Homebrew/cmd/update.sh @@ -5,7 +5,7 @@ #: If `--merge` is specified then `git merge` is used to include updates #: (rather than `git rebase`). #: -#: If `--force` is specified then always do a slower, full update check even +#: If `--force` (or `-f`) is specified then always do a slower, full update check even #: if unnecessary. # Hide shellcheck complaint: diff --git a/Library/Homebrew/dev-cmd/bottle.rb b/Library/Homebrew/dev-cmd/bottle.rb index b11da5607..8d3038a5a 100644 --- a/Library/Homebrew/dev-cmd/bottle.rb +++ b/Library/Homebrew/dev-cmd/bottle.rb @@ -6,7 +6,7 @@ #: generated DSL. Passing `--keep-old` will attempt to keep it at its #: original value, while `--no-rebuild` will remove it. #: -#: If `--verbose` is passed, print the bottling commands and any warnings +#: If `--verbose` (or `-v`) is passed, print the bottling commands and any warnings #: encountered. #: #: If `--skip-relocation` is passed, do not check if the bottle can be marked diff --git a/Library/Homebrew/dev-cmd/test.rb b/Library/Homebrew/dev-cmd/test.rb index 4898629b0..288aa8a87 100644 --- a/Library/Homebrew/dev-cmd/test.rb +++ b/Library/Homebrew/dev-cmd/test.rb @@ -7,7 +7,7 @@ #: To test the development or head version of a formula, use `--devel` or #: `--HEAD`. #: -#: If `--debug` is passed and the test fails, an interactive debugger will be +#: If `--debug` (or `-d`) is passed and the test fails, an interactive debugger will be #: launched with access to IRB or a shell inside the temporary test directory. #: #: If `--keep-tmp` is passed, the temporary files created for the test are diff --git a/Library/Homebrew/dev-cmd/tests.rb b/Library/Homebrew/dev-cmd/tests.rb index 18e7d96f2..91c7d880b 100644 --- a/Library/Homebrew/dev-cmd/tests.rb +++ b/Library/Homebrew/dev-cmd/tests.rb @@ -3,7 +3,7 @@ #: `--only=` runs only _spec.rb, and `--seed` #: randomizes tests with the provided value instead of a random seed. #: -#: If `--verbose` is passed, print the command that runs the tests. +#: If `--verbose` (or `-v`) is passed, print the command that runs the tests. #: #: If `--coverage` is passed, also generate code coverage reports. #: -- cgit v1.2.3