Commit Graph
1405 Commits
Author SHA1 Message Date
67e03a0675 Improve command descriptions
Co-Authored-By: Jonathan Chang <me@jonathanchang.org>
Co-Authored-By: Eric Knibbe <3324775+EricFromCanada@users.noreply.github.com>
2021-01-25 13:46:51 -05:00
Rylan Polster 7f23b55c5e Cleanup command descriptions
Don't have a period within first full sentence of the description
2021-01-25 13:46:35 -05:00
Mike McQuaidandGitHub d0e1c3dc5f Merge pull request #10400 from issyl0/improve-brew-extract-args
dev-cmd/extract: Improve the usage instructions
2021-01-25 09:55:01 +00:00
dependabot[bot]andGitHub f263000bcf build(deps-dev): bump github-pages from 209 to 210 in /docs
Bumps [github-pages](https://github.com/github/pages-gem) from 209 to 210.
- [Release notes](https://github.com/github/pages-gem/releases)
- [Commits](https://github.com/github/pages-gem/compare/v209...v210)

Signed-off-by: dependabot[bot] <support@github.com>
2021-01-25 05:46:36 +00:00
Rylan PolsterandGitHub 2c83ea7339 Merge pull request #10370 from Rylan12/brew-release
Add brew release command
2021-01-23 15:35:53 -05:00
Issy Long 49b9b6cf3f dev-cmd/extract: Improve the usage instructions
- A friend got an error message when trying to use `brew extract` and it
  wasn't immediately obvious to me why. The usage banner only mentioned
  the "formula" argument, which they'd provided. This improves the error
  message when there aren't enough arguments so that others have a
  chance of figuring out how to use this command without having to look
  at the code for `extract_args`.

Before:

```
➜ brew extract --version='1.4' libftdi
Usage: brew extract [--version=] [--force] formula ...
[...]
Error: Invalid usage: this command requires a formula argument
```

After:

```
➜ brew extract --version='1.4' libftdi
Usage: brew extract [options] formula tap
[...]
Error: Invalid usage: This command requires at least 2 named arguments.
```

- I don't like the "at least 2" phrasing here but that's a dive into the
  arg parsing code that I don't have time for right now. An alternative
  was `named_args [:formula, :destination_tap]`, but that gave the error
  message "requires formula or destination_tap" which wasn't great
  either. I also tried `min: 2, max: 2` and that was the same "at least
  2" message.
2021-01-23 20:01:11 +00:00
Mike McQuaidandGitHub 2268e774a4 Merge pull request #10301 from hyuraku/cmd/cleanup_add_desc_about_all_to_prune
cmd/cleanup: add description about all to --prune
2021-01-22 14:57:13 +00:00
hyuraku b4df0d5c10 cmd/cleanup: add desc about all to --prune 2021-01-22 20:53:48 +09:00
Rylan Polster f382f38034 docs: update release documentation 2021-01-21 18:30:17 -05:00
Rylan Polster be02591cb6 Add brew release command 2021-01-21 18:29:43 -05:00
Mike McQuaid 8cb2cc4bcc install-bundler-gem: allow on ARM.
Needed for CI:
https://github.com/Homebrew/homebrew-core/pull/69460/checks?check_run_id=1740727396#step:6:32
2021-01-21 10:02:57 +00:00
Mike McQuaidandGitHub 7360880780 Merge pull request #10375 from MikeMcQuaid/dev-cmd-arm
dev-cmd: disable when broken on Apple Silicon.
2021-01-21 09:01:16 +00:00
Mike McQuaidandGitHub e22f5f62d3 Merge pull request #10361 from tlk/patch-1
Clarification on the use of `:optional` and `:recommended`
2021-01-21 09:00:19 +00:00
Mike McQuaidandGitHub ea1affb658 Merge pull request #10373 from davidbailey00/patch-1
Suggest alternative method for enabling ZSH completions
2021-01-20 17:05:32 +00:00
Thomas L. KjeldsenandThomas L. Kjeldsen 72b29b2b2b Clarification on the use of :optional and :recommended 2021-01-20 16:54:10 +01:00
David BaileyandGitHub 39cdf234a2 Remove diff formatting (keep only relevant line) + clarify to append the line after initialization 2021-01-20 15:30:03 +00:00
a04b4890a9 Remove unneeded export
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2021-01-20 15:24:51 +00:00
Rylan PolsterandGitHub e172f0704e Merge pull request #10360 from Rylan12/bash-completions-files
completions: complete files where appropriate in bash
2021-01-20 09:19:25 -05:00
Mike McQuaid 3bc31d40bd dev-cmd: disable when broken on Apple Silicon.
This is better than users getting a weird error.
2021-01-20 14:07:44 +00:00
David BaileyandDavid Bailey 5bb1556246 Suggest alternative method for enabling ZSH completions 2021-01-20 12:28:49 +00:00
SeekerandGitHub 94f560f175 Merge pull request #10362 from tlk/patch-2
Replace :x11 symbol as it is no longer available
2021-01-19 16:10:54 -08:00
Rylan PolsterandGitHub 8c48547f0b Merge pull request #10333 from Rylan12/external-command-docs
docs: update external command documentation
2021-01-19 11:55:00 -05:00
Thomas L. KjeldsenandGitHub c10e18c06e Replace :x11 symbol as it is no longer available
The :x11 symbol was deprecated in https://github.com/Homebrew/brew/commit/87dd13aea6691e9d5e0f3ba8d1d1f862a809212a
2021-01-19 13:53:12 +01:00
Rylan Polster 4ef8c8279f completions: complete files where appropriate in bash 2021-01-19 01:03:05 -05:00
Rylan Polster 862ffb6e8b Updates after rebase on latest master
I didn't resolve the merge conflict correctly, I believe
2021-01-18 21:29:21 -05:00
Rylan Polster 1e4fef8123 usage string generator: fix handling of dashed-commands 2021-01-18 21:20:12 -05:00
Rylan Polster c8d32ff75a Updates after rebase on latest master 2021-01-18 21:20:12 -05:00
Rylan Polster a9a0c415e7 Cleanup usage strings for flags 2021-01-18 21:20:11 -05:00
Rylan Polster 6f69aab6cf Cleanup usage string
Include only global args and list the specific options if there are two or fewer.
2021-01-18 21:20:11 -05:00
Rylan Polster d1f3e39b7b Update commands to generate usage banner 2021-01-18 21:20:11 -05:00
Rylan Polster 4bf4d3e26e docs: update external command usage string instructions 2021-01-18 12:10:18 -05:00
Issy LongandDawid Dziurla a0f3545a86 dev-cmd/man: Completely remove --link
- This was deprecated in ec75fbcb65 in 2016!
2021-01-18 00:57:21 +01:00
6d3d88d33e Apply suggestions from code review
Co-authored-by: Eric Knibbe <enk3@outlook.com>
2021-01-15 10:11:27 -05:00
Dawid Dziurla f949d57437 cmd,dev-cmd: regenerate manpages and docs 2021-01-15 13:05:11 +01:00
Rylan Polster 617a2ea0a7 docs: update external command documentation 2021-01-14 20:34:46 -05:00
Shaun JackmanandGitHub edfa340646 Merge pull request #10137 from sjackman/sj/governance
Amend the governance document
2021-01-14 12:09:22 -08:00
Rylan PolsterandGitHub 701989968d Merge pull request #10268 from Rylan12/completions-opt-out
completions: make opt-in only
2021-01-13 16:08:30 -05:00
Rylan PolsterandMike McQuaid eb3a662841 completions: clarify that only external tap completions are affected
Co-Authored-By: Mike McQuaid <mike@mikemcquaid.com>
2021-01-12 16:31:24 -05:00
Mike McQuaidandGitHub bc0d1503e8 Merge pull request #7937 from samford/add-livecheck-author-doc
docs: add brew livecheck documentation
2021-01-12 09:03:44 +00:00
308390ba5b Address feedback and expand documentation
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
Co-authored-by: Sean Molenaar <1484494+SMillerDev@users.noreply.github.com>
2021-01-11 17:51:41 -05:00
Sam Ford 94f900ea87 docs: add brew livecheck documentation 2021-01-11 15:58:49 -05:00
Rylan Polster e7b369273a completions: link official taps automatically 2021-01-11 12:27:57 -05:00
Jonathan Chang ce45868973 Improve documentation and add type signatures. 2021-01-11 10:40:59 +11:00
Rylan Polster bed16128cc completions: fix usage text 2021-01-10 16:32:18 -05:00
Claudia PellegrinoandGitHub c8e2f3476f Merge pull request #10252 from Rylan12/python-docs-fix
docs: update homebrew-pypi-poet instructions
2021-01-08 20:32:09 +01:00
Shaun Jackman 17c25980f9 Governance: Accept suggestions of Rylan
Change "majority vote" to "ordinary resolution".
Change "Project Leadership Committee" to "PLC".
Add "with compromise".
2021-01-08 10:31:15 -08:00
Rylan Polster 74787ca0ee docs: update shell completions instructions 2021-01-08 11:26:33 -05:00
Rylan Polster 234267cc93 completions: make opt-in only 2021-01-08 11:10:24 -05:00
Mike McQuaidandGitHub 30d5fc6285 Merge pull request #10259 from kidonng/cask-completion
Add brew casks command
2021-01-08 13:04:53 +00:00
Mike McQuaidandGitHub 3b3d495021 Merge pull request #10239 from MikeMcQuaid/rubocop-shim
rubocop: add shim and command.
2021-01-08 13:04:35 +00:00