admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
24,930 Commits 15 Branches 471 Tags
Commit Graph

99 Commits

Author SHA1 Message Date
Mike McQuaid
b484f70572
Remove cask from man brew. 2020-11-25 09:37:21 +00:00
EricFromCanada
72bc057014 manpage: fixes for formatting 2020-11-16 08:02:50 -05:00
EricFromCanada
eb16624c5f manpage: reformat lists of subcommands & env vars 
Modify parser.rb to add a colon between each term and the line break, which `ronn` converts into a definition list.
The <br> that follows ensures each term description is on a new line in the manpage output, and also replaces the
double trailing space for generating the hard return that follows each term in the HTML output.
Also modify man.rb to print environment variables with list markup matching the cask commands, and then drop
trailing colons from both lists of terms (cask commands, env vars) and non-list terms (analytics, bundle, services;
a <br> is added here because it would prevent the term description from being indented in the manpage output).
https://docs.brew.sh/Manpage#cask-command-options-cask
 2020-11-16 07:56:50 -05:00
Markus Reiter
da9289eff0 Add more type signatures. 2020-11-13 12:26:36 +01:00
Markus Reiter
24ae318a3d Move type annotations into files. 2020-10-10 14:59:39 +02:00
Markus Reiter
7743fed77b Add “GLOBAL CASK OPTIONS” section to man page. 2020-10-08 11:07:35 +02:00
Markus Reiter
d443afc82d Improve brew man output. 2020-09-27 22:54:57 +02:00
Markus Reiter
540fa4e84b Pass quiet when tapping external commands. 2020-09-09 21:49:22 +02:00
Markus Reiter
b48bc316e0 Use CLI::Parser for cask commands. 2020-08-13 05:15:15 +02:00
Markus Reiter
48444d50af Refactor brew man. 2020-07-31 19:40:49 +02:00
Markus Reiter
d4c2ffd705 Refactor CLI::Parser. 2020-07-31 15:07:17 +02:00
Markus Reiter
e9ade913c4 Pass args in man instead of using global args. 2020-07-30 03:21:12 +02:00
Jonathan Chang
76709d82c5 Fix brew style. 2020-07-13 23:24:14 +10:00
Caleb Xu
a53c92bd7f Cache commands list for faster shell completions 2020-06-18 11:06:31 -04:00
Mike McQuaid
ad75e40ce7
man: generate from Homebrew::EnvConfig. 2020-04-07 09:58:26 +01:00
Mike McQuaid
2afeffc91b
man: include full help from external commands. 
Inspired by https://github.com/Homebrew/brew/issues/7148
 2020-03-11 12:22:46 +00:00
Mike McQuaid
f63d2d7887
man: be more exact about global options. 
Make clear these don't necessarily apply to all subcommands
(see https://github.com/Homebrew/brew/issues/7121).
 2020-03-11 12:16:47 +00:00
Mike McQuaid
8a9dcad2c7
Move more command handling logic to commands.rb. 2020-02-02 17:05:45 +01:00
Mike McQuaid
eb87651341
Revert "Revert "help: print cli/parser help message if used"" 2020-02-02 16:36:59 +01:00
Mike McQuaid
2082379a61
Revert "help: print cli/parser help message if used" 2020-02-02 09:11:23 +01:00
Mike McQuaid
b03efb4356
Move shared man/help logic to cli/parser. 2020-02-01 19:05:03 +01:00
Mike McQuaid
76711e3222
Fix Rubocop 0.78.0 failures. 2019-12-19 12:01:51 +00:00
EricFromCanada
aea6d79d21 option parser: check for extra named args 2019-12-15 00:04:45 -05:00
Jonathan Chang
81db0e9551 dev-cmd: enable frozen string literals 
Now that we use Ruby 2.6 we can fix these last two files.
 2019-11-04 21:00:20 +11:00
Issy Long
1f6168fe8a
Change regexp.match?(string) to string.match?(regexp) everywhere 
- Only try to call `.match?` on strings that aren't nil.
 2019-10-13 23:22:51 +01:00
Issy Long
69d84ebfd9
Auto-fix Lint/ErbNewArguments offenses 2019-10-13 16:04:29 +01:00
Issy Long
b78028b9c2
Auto-fix Performance/RegexpMatch offenses 2019-10-13 16:04:26 +01:00
Mike McQuaid
7ed95ab48e
man: die if blank output received. 2019-10-08 16:37:45 +01:00
EricFromCanada
2477773259 man: include global options with customized descriptions 2019-08-25 23:59:47 -04:00
EricFromCanada
3ed9b35f70 man: allow multi-line paragraphs for comment-based docs 2019-08-20 12:56:21 -04:00
EricFromCanada
8a8359cdd4 manpages: sentence rewording for readability 
Use active voice when applicable, better verbs & adjectives, preposition usage, proper tense, etc.
 2019-08-20 09:05:45 -04:00
Mike McQuaid
c4f72312ce
Fixup brew style failures. 2019-04-30 09:19:18 +01:00
Mike McQuaid
fc6bd2ea1c
Fixup more frozen string handling. 2019-04-20 14:07:29 +09:00
Mike McQuaid
36dbad3922
Add frozen_string_literal to all files. 2019-04-20 13:27:36 +09:00
Mike McQuaid
d1ea6f38d3
Fix mutable constants violations. 2019-04-19 21:46:20 +09:00
Mike McQuaid
e40b171127
Rename cli_parser to cli/parser. 2019-04-17 22:16:50 +09:00
Mike Miller
56ac7ed58b man: omit global options from shell command usage 
When reading the comment header of a shell command, omit options that
are in Homebrew::CLI::Parser.global_options, since they are documented
separately for all commands.
 2019-03-16 23:11:04 -07:00
Mike Miller
a4c8fc74f7 man: parse short and long options in shell commands 
Add a regex to handle two comma-separated options on the same line in
command help strings.
 2019-03-16 23:09:11 -07:00
Mike McQuaid
710859e300
Update Linuxbrew references to Homebrew on Linux 
This is a clearer branding for us to use.

Also, as part of testing this, make some fixes to Jekyll in the docs folder.

Fixes #5835
 2019-03-12 20:13:38 +00:00
Mike McQuaid
ba28853237
Merge pull request #5739 from MikeMcQuaid/governance 
Add/link Homebrew Governance document.
 2019-02-22 16:50:33 +00:00
Mike McQuaid
e095da4d01
rubocop: enable Layout/EmptyLineAfterGuardClause. 2019-02-21 12:55:49 +00:00
Mike McQuaid
d64429a736
rubocop: enable Style/IfUnlessModifier. 2019-02-21 12:55:49 +00:00
Mike McQuaid
aafcbc1153
Add/link Homebrew Governance document. 2019-02-15 10:54:30 +00:00
Mike McQuaid
947b90961b
Note leadership changes 
Today the Homebrew maintainers elected a new PLC, TSC and project lead.
Documentation is to follow detailing exactly the responsibilities for
each of these roles but adjust these to reflect the current state until
that point.
 2019-02-04 17:09:31 +01:00
Mike McQuaid
bbea109926
dev-cmd: remove --help headers and tweak docs. 2019-01-30 21:39:28 +00:00
Mike McQuaid
0fff6e0c09
man: improve manpage output. 2019-01-30 21:38:44 +00:00
Mike McQuaid
efc3c0c4c0
Use bundle install in more places. 
This provides a more consistent version for `rubocop` than relying on
`Homebrew.install_gem_setup_path!` (and we really want `brew style` to
provide consistent output).
 2019-01-08 15:08:21 +00:00
Gautham Goli
f7013d1738
man: Restore args after generating man pages from respective cmd parsers 2018-10-24 01:33:55 +05:30
EricFromCanada
388781f6a7 dev-cmd/: remove colons from command specs. 
These aren't needed when converting Parser-based help text to man page or Markdown formats.
Includes regenerated docs.
 2018-10-19 13:12:55 -04:00
EricFromCanada
7fb425a5c6 man.rb: avoid showing comma when an option has no long version. 
Specifically, `brew ruby -e "<ruby code>"`.
 2018-10-19 13:12:55 -04:00