From 847766140fcd1bb66d0472cb799c1732721ad700 Mon Sep 17 00:00:00 2001 From: metacollin Date: Thu, 19 Nov 2020 20:56:20 -0700 Subject: [PATCH] Doc problems --- completions/internal_commands_list.txt | 1 - docs/Manpage.md | 52 +++++++++++++------------- 2 files changed, 25 insertions(+), 28 deletions(-) diff --git a/completions/internal_commands_list.txt b/completions/internal_commands_list.txt index 9c91e9f1f3..0d277a1200 100644 --- a/completions/internal_commands_list.txt +++ b/completions/internal_commands_list.txt @@ -37,7 +37,6 @@ environment extract fetch formula -formulae gist-logs help home diff --git a/docs/Manpage.md b/docs/Manpage.md index abac7b1f37..9f5b14a52a 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -221,10 +221,6 @@ For tarballs, also print SHA-256 checksums. * `--force-bottle`: Download a bottle if it exists for the current or newest version of macOS, even if it would not be used during installation. -### `formulae` - -List all locally installable formulae including short names. - ### `gist-logs` [*`options`*] *`formula`* Upload logs for a failed build of *`formula`* to a new Gist. Presents an @@ -1425,12 +1421,14 @@ Bundler for non-Ruby dependencies from Homebrew, Homebrew Cask, Mac App Store an `brew bundle` [`install`]
Install and upgrade (by default) all dependencies from the `Brewfile`. -You can skip the installation of dependencies by adding space-separated values to one or more of the following environment variables: `HOMEBREW_BUNDLE_BREW_SKIP`, `HOMEBREW_BUNDLE_CASK_SKIP`, `HOMEBREW_BUNDLE_MAS_SKIP`, `HOMEBREW_BUNDLE_WHALEBREW_SKIP`, `HOMEBREW_BUNDLE_TAP_SKIP` +You can specify the `Brewfile` location using `--file` or by setting the `HOMEBREW_BUNDLE_FILE` environment variable. + +You can skip the installation of dependencies by adding space-separated values to one or more of the following environment variables: `HOMEBREW_BUNDLE_BREW_SKIP`, `HOMEBREW_BUNDLE_CASK_SKIP`, `HOMEBREW_BUNDLE_MAS_SKIP`, `HOMEBREW_BUNDLE_WHALEBREW_SKIP`, `HOMEBREW_BUNDLE_TAP_SKIP`. `brew bundle` will output a `Brewfile.lock.json` in the same directory as the `Brewfile` if all dependencies are installed successfully. This contains dependency and system status information which can be useful in debugging `brew bundle` failures and replicating a "last known good build" state. You can opt-out of this behaviour by setting the `HOMEBREW_BUNDLE_NO_LOCK` environment variable or passing the `--no-lock` option. You may wish to check this file into the same version control system as your `Brewfile` (or ensure your version control system ignores it if you'd prefer to rely on debugging information from a local machine). `brew bundle dump` -
Write all installed casks/formulae/images/taps into a `Brewfile`. +
Write all installed casks/formulae/images/taps into a `Brewfile` in the current directory. `brew bundle cleanup`
Uninstall all dependencies not listed from the `Brewfile`. @@ -1438,12 +1436,12 @@ You can skip the installation of dependencies by adding space-separated values t This workflow is useful for maintainers or testers who regularly install lots of formulae. `brew bundle check` -
Check if all dependencies are installed from the `Brewfile` . +
Check if all dependencies are installed from the `Brewfile`. This provides a successful exit code if everything is up-to-date, making it useful for scripting. `brew bundle list` -
List all dependencies present in a `Brewfile`. +
List all dependencies present in the `Brewfile`. By default, only Homebrew dependencies are listed. @@ -1513,46 +1511,46 @@ Otherwise, operate on `~/Library/LaunchAgents` (started at login). * `--all`: Run *`subcommand`* on all services. -### `test-bot` [*`options`*] [*`formula`*]: +### `test-bot` [*`options`*] [*`formula`*] -Tests the full lifecycle of a Homebrew change to a tap (Git repository). For example, for a GitHub Actions pull request that changes a formula `brew test-bot` will ensure the system is cleaned and setup to test the formula, install the formula, run various tests and checks on it, bottle (package) the binaries and test formulae that depend on it to ensure they aren't broken by these changes. +Tests the full lifecycle of a Homebrew change to a tap (Git repository). For example, for a GitHub Actions pull request that changes a formula `brew test-bot` will ensure the system is cleaned and set up to test the formula, install the formula, run various tests and checks on it, bottle (package) the binaries and test formulae that depend on it to ensure they aren't broken by these changes. Only supports GitHub Actions as a CI provider. This is because Homebrew uses GitHub Actions and it's freely available for public and private use with macOS and Linux workers. * `--dry-run`: - print what would be done rather than doing it. + Print what would be done rather than doing it. * `--cleanup`: - clean all state from the Homebrew directory. Use with care! + Clean all state from the Homebrew directory. Use with care! * `--skip-setup`: - don't check if the local system is set up correctly. + Don't check if the local system is set up correctly. * `--keep-old`: - run `brew bottle --keep-old` to build new bottles for a single platform. + Run `brew bottle --keep-old` to build new bottles for a single platform. * `--skip-relocation`: - run `brew bottle --skip-relocation` to build new bottles that don't require relocation. + Run `brew bottle --skip-relocation` to build new bottles that don't require relocation. * `--local`: - ask Homebrew to write verbose logs under `./logs/` and set `$HOME` to `./home/` + Ask Homebrew to write verbose logs under `./logs/` and set `$HOME` to `./home/` * `--tap`: - use the `git` repository of the given tap. Defaults to the core tap for syntax checking. + Use the Git repository of the given tap. Defaults to the core tap for syntax checking. * `--fail-fast`: - immediately exit on a failing step. + Immediately exit on a failing step. * `-v`, `--verbose`: - print test step output in real time. Has the side effect of passing output as raw bytes instead of re-encoding in UTF-8. + Print test step output in real time. Has the side effect of passing output as raw bytes instead of re-encoding in UTF-8. * `--test-default-formula`: - use a default testing formula when not building a tap and no other formulae are specified. + Use a default testing formula when not building a tap and no other formulae are specified. * `--bintray-org`: - upload to the given Bintray organisation. + Upload bottles to the given Bintray organisation. * `--root-url`: - use the specified *`URL`* as the root of the bottle's URL instead of Homebrew's default. + Use the specified *`URL`* as the root of the bottle's URL instead of Homebrew's default. * `--git-name`: - set the Git author/committer names to the given name. + Set the Git author/committer names to the given name. * `--git-email`: - set the Git author/committer email to the given email. + Set the Git author/committer email to the given email. * `--ci-upload`: - use the Homebrew CI bottle upload options. + Use the Homebrew CI bottle upload options. * `--publish`: - publish the uploaded bottles. + Publish the uploaded bottles. * `--skip-recursive-dependents`: - only test the direct dependents. + Only test the direct dependents. * `--only-cleanup-before`: Only run the pre-cleanup step. Needs `--cleanup`. * `--only-setup`: