From 4fd8aea015e051163ad623cccdaf416c870fed15 Mon Sep 17 00:00:00 2001 From: Mike McQuaid Date: Sat, 15 Jul 2017 12:57:34 +0100 Subject: 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. --- Library/Homebrew/dev-cmd/man.rb | 4 +++- Library/Homebrew/manpages/brew.1.md.erb | 2 ++ Library/README.md | 3 +++ 3 files changed, 8 insertions(+), 1 deletion(-) create mode 100644 Library/README.md (limited to 'Library') diff --git a/Library/Homebrew/dev-cmd/man.rb b/Library/Homebrew/dev-cmd/man.rb index 7ca22575f..472bb7c2b 100644 --- a/Library/Homebrew/dev-cmd/man.rb +++ b/Library/Homebrew/dev-cmd/man.rb @@ -65,7 +65,9 @@ module Homebrew readme = HOMEBREW_REPOSITORY/"README.md" variables[:lead_maintainer] = readme.read[/(Homebrew's lead maintainer .*\.)/, 1] .gsub(/\[([^\]]+)\]\([^)]+\)/, '\1') - variables[:maintainers] = readme.read[/(Homebrew's current maintainers .*\.)/, 1] + variables[:core_maintainer] = readme.read[%r{(Homebrew/homebrew-core's lead maintainer .*\.)}, 1] + .gsub(/\[([^\]]+)\]\([^)]+\)/, '\1') + variables[:maintainers] = readme.read[/(Homebrew's other current maintainers .*\.)/, 1] .gsub(/\[([^\]]+)\]\([^)]+\)/, '\1') variables[:former_maintainers] = readme.read[/(Former maintainers .*\.)/, 1] .gsub(/\[([^\]]+)\]\([^)]+\)/, '\1') diff --git a/Library/Homebrew/manpages/brew.1.md.erb b/Library/Homebrew/manpages/brew.1.md.erb index 0baa96755..589527d20 100644 --- a/Library/Homebrew/manpages/brew.1.md.erb +++ b/Library/Homebrew/manpages/brew.1.md.erb @@ -260,6 +260,8 @@ Homebrew Documentation: <%= lead_maintainer.concat("\n") %> +<%= core_maintainer.concat("\n") %> + <%= maintainers.concat("\n") %> <%= former_maintainers.concat("\n") %> diff --git a/Library/README.md b/Library/README.md new file mode 100644 index 000000000..1b3977172 --- /dev/null +++ b/Library/README.md @@ -0,0 +1,3 @@ +# Library + +This directory contains all the code run by the official `brew` and `brew cask` commands in `Homebrew` and all formulae (package descriptions) in taps (repositories containing formulae) in `Taps` subdirectories. -- cgit v1.2.3