admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

bottle: add --json and --merge docs.

Browse Source 
Fixes #4519.
This commit is contained in:
Mike McQuaid 2018-07-23 14:51:47 +01:00
parent db299035ac
commit 44eeb59774
3 changed files with 20 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Library/Homebrew/dev-cmd/bottle.rb
View File

@ -1,4 +1,4 @@
#: * `bottle` [`--verbose`] [`--no-rebuild`|`--keep-old`] [`--skip-relocation`] [`--or-later`] [`--root-url=`<URL>] [`--force-core-tap`] <formulae>: #: * `bottle` [`--verbose`] [`--no-rebuild`|`--keep-old`] [`--skip-relocation`] [`--or-later`] [`--root-url=`<URL>] [`--force-core-tap`] [`--json`] <formulae>:
#: Generate a bottle (binary package) from a formula installed with #: Generate a bottle (binary package) from a formula installed with
#: `--build-bottle`. #: `--build-bottle`.
#: #:
@ -20,17 +20,16 @@
#: If `--force-core-tap` is passed, build a bottle even if <formula> is not #: If `--force-core-tap` is passed, build a bottle even if <formula> is not
#: in homebrew/core or any installed taps. #: in homebrew/core or any installed taps.
#: #:
#: * `bottle` `--merge` [`--keep-old`] [`--write` [`--no-commit`]] <formulae>: #: If `--json` is passed, write bottle information to a JSON file, which can
#: Generate a bottle from a formula and print the new DSL merged into the #: be used as the argument for `--merge`.
#: existing formula. #:
#: * `bottle` `--merge` [`--keep-old`] [`--write` [`--no-commit`]] <bottle_json_files>:
#: Generate a bottle from a `--json` output file and print the new DSL merged
#: into the existing formula.
#: #:
#: If `--write` is passed, write the changes to the formula file. A new #: If `--write` is passed, write the changes to the formula file. A new
#: commit will then be generated unless `--no-commit` is passed. #: commit will then be generated unless `--no-commit` is passed.
# Undocumented options:
# `--json` writes bottle information to a JSON file, which can be used as
# the argument for `--merge`.
require "formula" require "formula"
require "utils/bottles" require "utils/bottles"
require "tab" require "tab"

11
docs/Manpage.md
View File

@ -687,7 +687,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
`audit` exits with a non-zero status if any errors are found. This is useful, `audit` exits with a non-zero status if any errors are found. This is useful,
for instance, for implementing pre-commit hooks. for instance, for implementing pre-commit hooks.
* `bottle` [`--verbose`] [`--no-rebuild`|`--keep-old`] [`--skip-relocation`] [`--or-later`] [`--root-url=``URL`] [`--force-core-tap`] `formulae`: * `bottle` [`--verbose`] [`--no-rebuild`|`--keep-old`] [`--skip-relocation`] [`--or-later`] [`--root-url=``URL`] [`--force-core-tap`] [`--json`] `formulae`:
Generate a bottle (binary package) from a formula installed with Generate a bottle (binary package) from a formula installed with
`--build-bottle`. `--build-bottle`.
@ -709,9 +709,12 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
If `--force-core-tap` is passed, build a bottle even if `formula` is not If `--force-core-tap` is passed, build a bottle even if `formula` is not
in homebrew/core or any installed taps. in homebrew/core or any installed taps.
* `bottle` `--merge` [`--keep-old`] [`--write` [`--no-commit`]] `formulae`: If `--json` is passed, write bottle information to a JSON file, which can
Generate a bottle from a formula and print the new DSL merged into the be used as the argument for `--merge`.
existing formula.
* `bottle` `--merge` [`--keep-old`] [`--write` [`--no-commit`]] `bottle_json_files`:
Generate a bottle from a `--json` output file and print the new DSL merged
into the existing formula.
If `--write` is passed, write the changes to the formula file. A new If `--write` is passed, write the changes to the formula file. A new
commit will then be generated unless `--no-commit` is passed. commit will then be generated unless `--no-commit` is passed.

9
manpages/brew.1
View File

@ -628,7 +628,7 @@ Passing \fB\-\-only\-cops=\fR\fIcops\fR will check for violations of only the li
\fBaudit\fR exits with a non\-zero status if any errors are found\. This is useful, for instance, for implementing pre\-commit hooks\. \fBaudit\fR exits with a non\-zero status if any errors are found\. This is useful, for instance, for implementing pre\-commit hooks\.
. .
.TP .TP
\fBbottle\fR [\fB\-\-verbose\fR] [\fB\-\-no\-rebuild\fR|\fB\-\-keep\-old\fR] [\fB\-\-skip\-relocation\fR] [\fB\-\-or\-later\fR] [\fB\-\-root\-url=\fR\fIURL\fR] [\fB\-\-force\-core\-tap\fR] \fIformulae\fR \fBbottle\fR [\fB\-\-verbose\fR] [\fB\-\-no\-rebuild\fR|\fB\-\-keep\-old\fR] [\fB\-\-skip\-relocation\fR] [\fB\-\-or\-later\fR] [\fB\-\-root\-url=\fR\fIURL\fR] [\fB\-\-force\-core\-tap\fR] [\fB\-\-json\fR] \fIformulae\fR
Generate a bottle (binary package) from a formula installed with \fB\-\-build\-bottle\fR\. Generate a bottle (binary package) from a formula installed with \fB\-\-build\-bottle\fR\.
. .
.IP .IP
@ -649,9 +649,12 @@ If \fB\-\-or\-later\fR is passed, append _or_later to the bottle tag\.
.IP .IP
If \fB\-\-force\-core\-tap\fR is passed, build a bottle even if \fIformula\fR is not in homebrew/core or any installed taps\. If \fB\-\-force\-core\-tap\fR is passed, build a bottle even if \fIformula\fR is not in homebrew/core or any installed taps\.
. .
.IP
If \fB\-\-json\fR is passed, write bottle information to a JSON file, which can be used as the argument for \fB\-\-merge\fR\.
.
.TP .TP
\fBbottle\fR \fB\-\-merge\fR [\fB\-\-keep\-old\fR] [\fB\-\-write\fR [\fB\-\-no\-commit\fR]] \fIformulae\fR \fBbottle\fR \fB\-\-merge\fR [\fB\-\-keep\-old\fR] [\fB\-\-write\fR [\fB\-\-no\-commit\fR]] \fIbottle_json_files\fR
Generate a bottle from a formula and print the new DSL merged into the existing formula\. Generate a bottle from a \fB\-\-json\fR output file and print the new DSL merged into the existing formula\.
. .
.IP .IP
If \fB\-\-write\fR is passed, write the changes to the formula file\. A new commit will then be generated unless \fB\-\-no\-commit\fR is passed\. If \fB\-\-write\fR is passed, write the changes to the formula file\. A new commit will then be generated unless \fB\-\-no\-commit\fR is passed\.