From aee23ccb0355228f24d387fcbe7cf5d30f57d8b6 Mon Sep 17 00:00:00 2001 From: EricFromCanada Date: Sun, 5 Mar 2017 21:45:15 -0500 Subject: Add more flags and descriptions to man pages. --- Library/Homebrew/dev-cmd/bottle.rb | 26 ++++++++++++++++++++++++-- Library/Homebrew/dev-cmd/tests.rb | 20 ++++++++++++++++++-- Library/Homebrew/dev-cmd/update-test.rb | 2 +- 3 files changed, 43 insertions(+), 5 deletions(-) (limited to 'Library/Homebrew/dev-cmd') diff --git a/Library/Homebrew/dev-cmd/bottle.rb b/Library/Homebrew/dev-cmd/bottle.rb index 91bdcba93..619986f76 100644 --- a/Library/Homebrew/dev-cmd/bottle.rb +++ b/Library/Homebrew/dev-cmd/bottle.rb @@ -1,7 +1,29 @@ -#: * `bottle` [`--verbose`] [`--no-rebuild`] [`--keep-old`] [`--skip-relocation`] [`--root-url=`] [`--force-core-tap`]: -#: * `bottle` `--merge` [`--no-commit`] [`--keep-old`] [`--write`]: +#: * `bottle` [`--verbose`] [`--no-rebuild`|`--keep-old`] [`--skip-relocation`] [`--root-url=`] [`--force-core-tap`] : #: Generate a bottle (binary package) from a formula installed with #: `--build-bottle`. +#: +#: If the formula specifies a rebuild version, it will be incremented in the +#: 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 +#: encountered. +#: +#: If `--skip-relocation` is passed, do not check if the bottle can be marked +#: as relocatable. +#: +#: If `--root-url` is passed, use the specified as the root of the +#: bottle's URL instead of Homebrew's default. +#: +#: If `--force-core-tap` is passed, build a bottle even if is not +#: in homebrew/core or any installed taps. +#: +#: * `bottle` `--merge` [`--keep-old`] [`--write` [`--no-commit`]] : +#: Generate a bottle from a formula and print the new DSL merged into the +#: existing formula. +#: +#: If `--write` is passed, write the changes to the formula file. A new +#: commit will then be generated unless `--no-commit` is passed. require "formula" require "utils/bottles" diff --git a/Library/Homebrew/dev-cmd/tests.rb b/Library/Homebrew/dev-cmd/tests.rb index b66d8db16..4f7f9e771 100644 --- a/Library/Homebrew/dev-cmd/tests.rb +++ b/Library/Homebrew/dev-cmd/tests.rb @@ -1,5 +1,21 @@ -#: * `tests` [`-v`] [`--coverage`] [`--generic`] [`--no-compat`] [`--only=``:`] [`--seed` ] [`--online`] [`--official-cmd-taps`]: -#: Run Homebrew's unit and integration tests. +#: * `tests` [`--verbose`] [`--coverage`] [`--generic`] [`--no-compat`] [`--only=`[`:`]] [`--seed` ] [`--online`] [`--official-cmd-taps`]: +#: Run Homebrew's unit and integration tests. If provided, +#: `--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 `--coverage` is passed, also generate code coverage reports. +#: +#: If `--generic` is passed, only run OS-agnostic tests. +#: +#: If `--no-compat` is passed, do not load the compatibility layer when +#: running tests. +#: +#: If `--online` is passed, include tests that use the GitHub API. +#: +#: If `--official-cmd-taps` is passed, include tests that use any of the +#: taps for official external commands. require "fileutils" require "tap" diff --git a/Library/Homebrew/dev-cmd/update-test.rb b/Library/Homebrew/dev-cmd/update-test.rb index 9704426dd..2ff168669 100644 --- a/Library/Homebrew/dev-cmd/update-test.rb +++ b/Library/Homebrew/dev-cmd/update-test.rb @@ -1,4 +1,4 @@ -#: * `update-test` [`--commit=`] [`--before=`] [`--keep-tmp`]: +#: * `update-test` [`--commit=`] [`--before=`] [`--to-tag`] [`--keep-tmp`]: #: Runs a test of `brew update` with a new repository clone. #: #: If no arguments are passed, use `origin/master` as the start commit. -- cgit v1.2.3