diff options
| author | Mike McQuaid | 2016-09-20 09:49:38 +0100 | 
|---|---|---|
| committer | GitHub | 2016-09-20 09:49:38 +0100 | 
| commit | f87e3626bb241bc88bead4ed6448a76c1bf49f56 (patch) | |
| tree | a00b45724f0fb92675dde3bb7a8d1c5a4b6ad2c7 | |
| parent | ea2af7736359f01ac74047ff886857e0a5c0eb37 (diff) | |
| parent | 51ed08d733de8560048807c06eac63067f42788b (diff) | |
| download | brew-f87e3626bb241bc88bead4ed6448a76c1bf49f56.tar.bz2 | |
Merge pull request #1039 from MikeMcQuaid/readme-tweaks
Readme tweaks
| -rw-r--r-- | Library/Homebrew/dev-cmd/man.rb | 11 | ||||
| -rw-r--r-- | Library/Homebrew/manpages/brew.1.md.erb | 4 | ||||
| -rw-r--r-- | README.md | 4 | ||||
| -rw-r--r-- | share/doc/homebrew/brew.1.html | 16 | ||||
| -rw-r--r-- | share/man/man1/brew.1 | 17 | 
5 files changed, 30 insertions, 22 deletions
| diff --git a/Library/Homebrew/dev-cmd/man.rb b/Library/Homebrew/dev-cmd/man.rb index 8b20158ef..f90aa6d2a 100644 --- a/Library/Homebrew/dev-cmd/man.rb +++ b/Library/Homebrew/dev-cmd/man.rb @@ -51,9 +51,18 @@ module Homebrew      variables[:commands] = path_glob_commands("#{HOMEBREW_LIBRARY_PATH}/cmd/*.{rb,sh}")      variables[:developer_commands] = path_glob_commands("#{HOMEBREW_LIBRARY_PATH}/dev-cmd/*.{rb,sh}") -    variables[:maintainers] = (HOMEBREW_REPOSITORY/"README.md") +    readme = HOMEBREW_REPOSITORY/"README.md" +    variables[:lead_maintainer] = readme +                                  .read[/Homebrew's lead maintainer is (.*)\./, 1] +                                  .scan(/\[([^\]]*)\]/).flatten.first +    variables[:maintainers] = readme                                .read[/Homebrew's current maintainers are (.*)\./, 1]                                .scan(/\[([^\]]*)\]/).flatten +    former_maintainers = readme +                         .read[/Former maintainers with significant contributions include (.*)\./, 1] +                         .scan(/\[([^\]]*)\]/).flatten +    variables[:former_maintainers] = former_maintainers[0...-1] +    variables[:creator] = former_maintainers.last      ERB.new(template, nil, ">").result(variables.instance_eval { binding })    end diff --git a/Library/Homebrew/manpages/brew.1.md.erb b/Library/Homebrew/manpages/brew.1.md.erb index bb6a15261..f856b50ee 100644 --- a/Library/Homebrew/manpages/brew.1.md.erb +++ b/Library/Homebrew/manpages/brew.1.md.erb @@ -255,9 +255,11 @@ Homebrew Documentation: <https://github.com/Homebrew/brew/blob/master/share/doc/  ## AUTHORS +Homebrew's lead maintainer is <%= lead_maintainer %>. +  Homebrew's current maintainers are <%= maintainers[0...-1].join(", ") %> and <%= maintainers[-1] %>. -Former maintainers with significant contributions include Jack Nagel, Adam Vandenberg and Homebrew's creator: Max Howell. +Former maintainers with significant contributions include <%= former_maintainers.join(", ") %> and Homebrew's creator: <%= creator %>.  ## BUGS @@ -38,7 +38,9 @@ This is our PGP key which is valid until May 24, 2017.  * Full key: https://keybase.io/homebrew/key.asc  ## Who Are You? -Homebrew's current maintainers are [Misty De Meo](https://github.com/mistydemeo), [Andrew Janke](https://github.com/apjanke), [Xu Cheng](https://github.com/xu-cheng), [Tomasz Pajor](https://github.com/nijikon), [Mike McQuaid](https://github.com/mikemcquaid), [Baptiste Fontaine](https://github.com/bfontaine), [Brett Koonce](https://github.com/asparagui), [ilovezfs](https://github.com/ilovezfs), [Martin Afanasjew](https://github.com/UniqMartin), [Dominyk Tiller](https://github.com/DomT4), [Tim Smith](https://github.com/tdsmith) and [Alex Dunn](https://github.com/dunn). +Homebrew's lead maintainer is [Mike McQuaid](https://github.com/mikemcquaid). + +Homebrew's current maintainers are [Misty De Meo](https://github.com/mistydemeo), [Andrew Janke](https://github.com/apjanke), [Xu Cheng](https://github.com/xu-cheng), [Tomasz Pajor](https://github.com/nijikon), [Baptiste Fontaine](https://github.com/bfontaine), [Zhiming Wang](https://github.com/zmwangx), [Brett Koonce](https://github.com/asparagui), [ilovezfs](https://github.com/ilovezfs), [Martin Afanasjew](https://github.com/UniqMartin), [Uladzislau Shablinski](https://github.com/orgs/Homebrew/people/vladshablinsky), [Dominyk Tiller](https://github.com/DomT4), [Tim Smith](https://github.com/tdsmith) and [Alex Dunn](https://github.com/dunn).  Former maintainers with significant contributions include [Jack Nagel](https://github.com/jacknagel), [Adam Vandenberg](https://github.com/adamv) and Homebrew's creator: [Max Howell](https://github.com/mxcl). diff --git a/share/doc/homebrew/brew.1.html b/share/doc/homebrew/brew.1.html index 6948b3f93..7e1e04e94 100644 --- a/share/doc/homebrew/brew.1.html +++ b/share/doc/homebrew/brew.1.html @@ -297,18 +297,14 @@ Homebrew build logic to help your <code>./configure && make && m  or even your <code>gem install</code> succeed. Especially handy if you run Homebrew  in an Xcode-only configuration since it adds tools like <code>make</code> to your <code>PATH</code>  which otherwise build-systems would not find.</p></dd> -<dt><code>style</code> [<code>--fix</code>] [<code>--display-cop-names</code>] [<var>formulae</var>|<var>files</var>]</dt><dd><p>Check formulae or files for conformance to Homebrew style guidelines.</p> - -<p><var>formulae</var> is a list of formula names.</p> - -<p><var>files</var> is a list of file names.</p> +<dt><code>style</code> [<code>--fix</code>] [<code>--display-cop-names</code>] [<var>files</var>|<var>taps</var>|<var>formulae</var>]</dt><dd><p>Check formulae or files for conformance to Homebrew style guidelines.</p>  <p><var>formulae</var> and <var>files</var> may not be combined. If both are omitted, style will run  style checks on the whole Homebrew <code>Library</code>, including core code and all  formulae.</p> -<p>If <code>--fix</code> is passed and <code>HOMEBREW_DEVELOPER</code> is set, style violations -will be automatically fixed using RuboCop's <code>--auto-correct</code> feature.</p> +<p>If <code>--fix</code> is passed, style violations will be automatically fixed using +RuboCop's <code>--auto-correct</code> feature.</p>  <p>If <code>--display-cop-names</code> is passed, the RuboCop cop name for each violation  is included in the output.</p> @@ -731,9 +727,11 @@ your shell profile, or you can use it before a brew command:</p>  <h2 id="AUTHORS">AUTHORS</h2> -<p>Homebrew's current maintainers are Misty De Meo, Andrew Janke, Xu Cheng, Tomasz Pajor, Mike McQuaid, Baptiste Fontaine, Brett Koonce, ilovezfs, Martin Afanasjew, Dominyk Tiller, Tim Smith and Alex Dunn.</p> +<p>Homebrew's lead maintainer is Mike McQuaid.</p> + +<p>Homebrew's current maintainers are Misty De Meo, Andrew Janke, Xu Cheng, Tomasz Pajor, Baptiste Fontaine, Zhiming Wang, Brett Koonce, ilovezfs, Martin Afanasjew, Uladzislau Shablinski, Dominyk Tiller, Tim Smith and Alex Dunn.</p> -<p>Former maintainers with significant contributions include Jack Nagel, Adam Vandenberg and Homebrew's creator: Max Howell.</p> +<p>Former maintainers with significant contributions include Jack Nagel, Adam Vandenberg, Max Howell and Homebrew's creator: Max Howell.</p>  <h2 id="BUGS">BUGS</h2> diff --git a/share/man/man1/brew.1 b/share/man/man1/brew.1 index 3cd37e64d..532c0fc91 100644 --- a/share/man/man1/brew.1 +++ b/share/man/man1/brew.1 @@ -403,20 +403,14 @@ Search for \fItext\fR in the given package manager\'s list\.  Instantiate a Homebrew build environment\. Uses our years\-battle\-hardened Homebrew build logic to help your \fB\./configure && make && make install\fR or even your \fBgem install\fR succeed\. Especially handy if you run Homebrew in an Xcode\-only configuration since it adds tools like \fBmake\fR to your \fBPATH\fR which otherwise build\-systems would not find\.  .  .TP -\fBstyle\fR [\fB\-\-fix\fR] [\fB\-\-display\-cop\-names\fR] [\fIformulae\fR|\fIfiles\fR] +\fBstyle\fR [\fB\-\-fix\fR] [\fB\-\-display\-cop\-names\fR] [\fIfiles\fR|\fItaps\fR|\fIformulae\fR]  Check formulae or files for conformance to Homebrew style guidelines\.  .  .IP -\fIformulae\fR is a list of formula names\. -. -.IP -\fIfiles\fR is a list of file names\. -. -.IP  \fIformulae\fR and \fIfiles\fR may not be combined\. If both are omitted, style will run style checks on the whole Homebrew \fBLibrary\fR, including core code and all formulae\.  .  .IP -If \fB\-\-fix\fR is passed and \fBHOMEBREW_DEVELOPER\fR is set, style violations will be automatically fixed using RuboCop\'s \fB\-\-auto\-correct\fR feature\. +If \fB\-\-fix\fR is passed, style violations will be automatically fixed using RuboCop\'s \fB\-\-auto\-correct\fR feature\.  .  .IP  If \fB\-\-display\-cop\-names\fR is passed, the RuboCop cop name for each violation is included in the output\. @@ -1001,10 +995,13 @@ Homebrew Documentation: \fIhttps://github\.com/Homebrew/brew/blob/master/share/d  \fBgit\fR(1), \fBgit\-log\fR(1)  .  .SH "AUTHORS" -Homebrew\'s current maintainers are Misty De Meo, Andrew Janke, Xu Cheng, Tomasz Pajor, Mike McQuaid, Baptiste Fontaine, Brett Koonce, ilovezfs, Martin Afanasjew, Dominyk Tiller, Tim Smith and Alex Dunn\. +Homebrew\'s lead maintainer is Mike McQuaid\. +. +.P +Homebrew\'s current maintainers are Misty De Meo, Andrew Janke, Xu Cheng, Tomasz Pajor, Baptiste Fontaine, Zhiming Wang, Brett Koonce, ilovezfs, Martin Afanasjew, Uladzislau Shablinski, Dominyk Tiller, Tim Smith and Alex Dunn\.  .  .P -Former maintainers with significant contributions include Jack Nagel, Adam Vandenberg and Homebrew\'s creator: Max Howell\. +Former maintainers with significant contributions include Jack Nagel, Adam Vandenberg, Max Howell and Homebrew\'s creator: Max Howell\.  .  .SH "BUGS"  See our issues on GitHub: | 
