vhad/brew
1
0
Fork 0
mirror of https://github.com/gosticks/brew.git synced 2026-08-31 05:50:22 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
19,113 Commits 4 Branches 271 Tags
33bb153dfd3bdb259ba7d1e63e400a9c1bceca02
Commit Graph
71 Commits
Author SHA1 Message Date
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 McQuaidandGitHub 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
EricFromCanada 63b3d400e0 dev-cmd/: add Parser-based help text for remaining commands. 
`brew ruby` now accepts only `-e`, verbose, and debug arguments.
 2018-10-19 13:12:55 -04:00
EricFromCanada ddf057f3dd dev-cmd/: edit help text and descriptions. 2018-10-19 13:12:11 -04:00
Mike McQuaid 448096168b Update manpages 
- dev-cmd/man: sort the `cmd_path`s (for APFS)
- update manpages based on latest content
 2018-10-10 14:41:50 +01:00
EricFromCanada b2b8f632bb docs: distinguish <code> and <var> in HTML output 
Replace <var> tags with markup for italicized monospaced text in Markdown.
This requires the source to not combine bracketed and backticked text.
 2018-10-06 00:51:13 -04:00
EricFromCanada dbea3cbe90 restore sorting of options after commands 2018-10-06 00:47:58 -04:00
EricFromCanada 997a207889 docs: fix Official External Commands section 
Work around ronn's inability to nest indents within list items by modifying its output to add a line break and indent after lines ending with a colon that aren't a list item's first line. This allows `brew.1.md.erb` to join the commands' help text without extra line breaks, which avoids the issue where kramdown was turning any command specs containing pipe characters into tables in the HTML output.
 2018-10-05 23:47:48 -04:00
Gautham Goli 38feaf1270 extract: Add option descriptions 2018-10-03 20:18:05 +05:30
Gautham Goli a03d2e0cd1 man: Correct option synopsis 2018-10-03 19:49:46 +05:30
Gautham Goli 7b0f27ca39 style: Fix style errors 2018-10-03 19:49:46 +05:30
Gautham Goli f60582ca48 man: Remove [] from command synopsis 2018-10-03 19:49:45 +05:30
Gautham Goli 3c74683d88 man: Format h3 tags in ronn output 2018-10-03 19:49:45 +05:30
Gautham Goli 446b1cb9e3 man: Seperate global options into a section 2018-10-03 19:49:45 +05:30
Gautham Goli e0e876cf37 man: Make command heading H3 2018-10-03 19:49:44 +05:30
Gautham Goli 4f58f2db99 man: Generate dev cmd manpages 2018-10-03 19:49:41 +05:30
Gautham Goli cfaaa0eb71 Move option descriptions to new line 2018-10-03 19:20:26 +05:30
Gautham Goli c7bf79407a Better man page formatting 2018-10-03 19:20:26 +05:30
Gautham Goli b6c456b681 Extract out arg parsing method to <cmd>_args method 2018-10-03 19:19:04 +05:30
Mike McQuaid bcb1ec5499 Improve Homebrew/brew line length. 
Use 124 max line length everywhere. Also, reduce tap max line length to
189 as Homebrew/homebrew-core has that as a maximum now. In future
Homebrew/homebrew-core will also be reduced to 124 maximum line length.
 2018-09-02 16:15:09 +01:00
Mike McQuaid daa3e415d6 Add/remove more maintainers. 
And remove the Homebrew/homebrew-core lead maintainer role.
 2018-08-08 09:41:26 +01:00
Mike McQuaid ba410959c0 Add new maintainers 
Also add some who were missing (sorry folks) and our Linux maintainers.
 2018-08-07 10:51:16 +01:00
Mike McQuaid ee5a073b05 Add the SFC PLC to the README and manpage. 
Let's document these so people know who the leadership team behind the
project is.
 2018-08-02 13:26:02 +01:00
Mike McQuaid b89e4c51ce man: improve messaging on no ronn output. 
This can happen if your gems are messed up and it's a more helpful
error message than being unable to `gsub` on `nil`.
 2018-07-20 09:47:28 +01:00
Gautham Goli fba52e2f74 cli_parser: Store parsed args in Homebrew.args and access args everywhere else 2018-05-30 00:05:39 +05:30
Gautham Goli ed387572ec cli_parser: Add class method to make options declaration more readable 2018-03-25 18:02:29 +05:30
Gautham Goli 78b41b07f1 man: Use Parser to parse args 2018-03-24 21:26:16 +05:30
Mike McQuaid b23f66982f Improve external command documentation 
Extract `brew bundle` and `brew services` docs from their help. Add a
little for `brew cask` until we can think about e.g. merging the
manpages.
 2018-03-15 16:25:14 +00:00
EricFromCanada 91246c2553 docs: fix double backticks appearing in HTML manpage 2018-02-01 17:17:09 -05:00
Mike McQuaid 65695885b6 Update other Homebrew maintainers. 2018-01-18 15:45:51 +00:00