85 Commits

Author SHA1 Message Date
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
Markus Reiter
175ca909ee Clean up code style and remove .rubocop_todo.yml. 2017-10-08 16:10:37 +02:00
Mike McQuaid
4fd8aea015 Documentation improvements
- Document ilovezfs as the official lead maintainer of
 Homebrew/homebrew-core. This is a role he's been doing unofficially
 (and brilliantly) for a while and explicit documentation of power
 structures makes it easier for non-Homebrew-maintainers to understand.
- Document the contents of some of Homebrew's subdirectories for people
  clicking around in the GitHub UI looking to contribute.
- Remove update bug mention from README. Enough time has passed that we
  can remove this disappointment.
2017-07-15 12:57:34 +01:00
Mike McQuaid
7a0aff1080 Autocorrect Rubocop Style/PerlBackrefs. 2017-06-10 20:23:20 +03:00
Mike McQuaid
57db2e539e Revert "Merge pull request #2597 from MikeMcQuaid/vendor-gems"
This reverts commit 3e4547f52e7ebec633f8bfefc8a396d944edf908, reversing
changes made to 6edf9382bcc1240ad6f97c8b752cfe56cef9965d.
2017-05-07 17:28:39 +01:00
Mike McQuaid
ee253e465b Vendor all Homebrew's gems.
Homebrew's actually ended up using a fair few gems. While we want to
avoid Bundler at runtime (and this PR still does that, in fact uses
Bundler even less at runtime than it did before) writing our own version
to use at build-time seems redundant.
2017-05-07 13:52:57 +01:00
Mike McQuaid
bfcfdb4f01 man: strip </?var> from Markdown output. 2017-04-02 10:14:57 +01:00
Mike McQuaid
650c33e73b man: generate Markdown man page.
The existing `brew.1.html` wasn't particularly pleasant to read and
given everything else in `docs/` is a Markdown file it makes sense to
generate a post-processed Markdown file that can in turn be used by
Jekyll to generate a nicely themed HTML file.
2017-03-22 21:38:41 +00:00
Alyssa Ross
4291476fa3 man: remove an unnecessary else
`odie` causes the process to exit immediately, so there's no need for the
`regenerate_man_pages` call to be conditional.
2017-01-23 21:16:49 +00:00
Josh Hagins
1d8e59b31f dev-cmd/man: use SOURCE_PATH instead of HOMEBREW_LIBRARY
Don't Repeat Yourself.
2016-10-23 01:22:56 -04:00
Markus Reiter
c36f42ce95 Remove private_class_method from commands. 2016-10-02 00:24:47 +02:00
Markus Reiter
0ab750bf24 Use module_function for commands. 2016-10-02 00:24:47 +02:00
Mike McQuaid
099f69e612 man: note --fail-if-changed date behaviour change.
As requested in #1199 this updates the documentation accordingly for
that change.
2016-10-01 12:19:51 +01:00
Mike McQuaid
c4adc68016 man: set date when --fail-if-changed.
Set the manpage date to the existing one if we're checking for changes.
This avoids the only change being e.g. a new date.
2016-10-01 11:49:39 +01:00
Steven Peters
44d13ce256 dev-cmd/man: display diff --stat, add --exit-code
The --fail-if-changed option will cause `brew man`
to return a failing status code if the man files
have changed.
2016-09-29 18:21:49 -07:00
Markus Reiter
4a9ee8154a Simplify brew man authors. 2016-09-20 12:12:36 +02:00
Mike McQuaid
205773b885 man: use new manpages/docs locations. 2016-09-20 10:41:42 +01:00
Mike McQuaid
51ed08d733 man: read lead, former maintainers, creator. 2016-09-20 09:31:19 +01:00
Mike McQuaid
71fd2bb4b0 dev-cmd/man: fix Rubocop warnings. 2016-09-11 19:14:55 +01:00
Mike McQuaid
71881fd7a6 Add DEVELOPER COMMANDS to manpage. 2016-09-08 20:46:51 +01:00
Mike McQuaid
86bfd36af2 Don't hide some (now) developer commands. 2016-09-08 20:46:37 +01:00
Mike McQuaid
af8605ea4b Move developer-focused commands to dev-cmd. 2016-09-08 20:46:37 +01:00