mirrors/brew
1
0
Fork 0
mirror of https://github.com/Homebrew/brew.git synced 2025-07-14 16:09:03 +08:00
Code Issues Packages Projects Releases Wiki Activity
18,042 Commits 11 Branches 451 Tags
Commit Graph

57 Commits

Author SHA1 Message Date
Mike McQuaid
d64429a736
rubocop: enable Style/IfUnlessModifier. 2019-02-21 12:55:49 +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
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