diff options
| author | Mike McQuaid | 2017-03-22 21:37:09 +0000 |
|---|---|---|
| committer | Mike McQuaid | 2017-03-22 21:38:41 +0000 |
| commit | 650c33e73be0b9159a9f01aed50e8830bbc6608e (patch) | |
| tree | f8da04d2e4041c1c2cc8d8ec95e42f4dc86419ff /Library/Homebrew/dev-cmd/man.rb | |
| parent | 17cc40f112cbb7e5da5ef6d8eb3e3d5afbbd43e5 (diff) | |
| download | brew-650c33e73be0b9159a9f01aed50e8830bbc6608e.tar.bz2 | |
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.
Diffstat (limited to 'Library/Homebrew/dev-cmd/man.rb')
| -rw-r--r-- | Library/Homebrew/dev-cmd/man.rb | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/Library/Homebrew/dev-cmd/man.rb b/Library/Homebrew/dev-cmd/man.rb index 581db38ca..a146f23a8 100644 --- a/Library/Homebrew/dev-cmd/man.rb +++ b/Library/Homebrew/dev-cmd/man.rb @@ -27,7 +27,7 @@ module Homebrew regenerate_man_pages - if system "git", "-C", HOMEBREW_REPOSITORY, "diff", "--quiet", "docs/brew.1.html", "manpages" + if system "git", "-C", HOMEBREW_REPOSITORY, "diff", "--quiet", "docs/Manpage.md", "manpages" puts "No changes to manpage output detected." elsif ARGV.include?("--fail-if-changed") Homebrew.failed = true @@ -38,7 +38,7 @@ module Homebrew Homebrew.install_gem_setup_path! "ronn" markup = build_man_page - convert_man_page(markup, TARGET_DOC_PATH/"brew.1.html") + convert_man_page(markup, TARGET_DOC_PATH/"Manpage.md") convert_man_page(markup, TARGET_MAN_PATH/"brew.1") cask_markup = (SOURCE_PATH/"brew-cask.1.md").read @@ -53,8 +53,7 @@ module Homebrew .grep(/^#:/) .map { |line| line.slice(2..-1) } .join - end - .reject { |s| s.strip.empty? || s.include?("@hide_from_man_page") } + end.reject { |s| s.strip.empty? || s.include?("@hide_from_man_page") } end def build_man_page @@ -113,7 +112,7 @@ module Homebrew def target_path_to_format(target) case target.basename - when /\.html?$/ then ["--fragment", "HTML fragment"] + when /\.md$/ then ["--markdown", "markdown"] when /\.\d$/ then ["--roff", "man page"] else odie "Failed to infer output format from '#{target.basename}'." |