aboutsummaryrefslogtreecommitdiffstats
path: root/Library/Homebrew/cmd/man.rb
diff options
context:
space:
mode:
authorMike McQuaid2015-08-29 10:56:24 +0100
committerMike McQuaid2015-08-29 15:43:16 +0100
commit2c959a7d5847094d316278188e816a7dadc1a090 (patch)
tree1788b7791102363b7eab595f1346e3199b4de80a /Library/Homebrew/cmd/man.rb
parent77536e39de0368a0ba3ca2b46f0417abdf75aadf (diff)
downloadbrew-2c959a7d5847094d316278188e816a7dadc1a090.tar.bz2
More API documentation.
And remove the documented stuff from the `example-formula.rb`. Closes Homebrew/homebrew#43241. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
Diffstat (limited to 'Library/Homebrew/cmd/man.rb')
-rw-r--r--Library/Homebrew/cmd/man.rb8
1 files changed, 6 insertions, 2 deletions
diff --git a/Library/Homebrew/cmd/man.rb b/Library/Homebrew/cmd/man.rb
index 5c4abbe39..208c07d47 100644
--- a/Library/Homebrew/cmd/man.rb
+++ b/Library/Homebrew/cmd/man.rb
@@ -3,6 +3,7 @@ require "formula"
module Homebrew
SOURCE_PATH=HOMEBREW_REPOSITORY/"Library/Homebrew/manpages"
TARGET_PATH=HOMEBREW_REPOSITORY/"share/man/man1"
+ DOC_PATH=HOMEBREW_REPOSITORY/"share/doc/homebrew"
LINKED_PATH=HOMEBREW_PREFIX/"share/man/man1"
def man
@@ -21,12 +22,15 @@ module Homebrew
else
Homebrew.install_gem_setup_path! "ronn"
+ puts "Writing HTML fragments to #{DOC_PATH}"
puts "Writing manpages to #{TARGET_PATH}"
target_file = nil
Dir["#{SOURCE_PATH}/*.md"].each do |source_file|
- target_file = TARGET_PATH/File.basename(source_file, ".md")
- safe_system "ronn --roff --pipe --organization='Homebrew' --manual='brew' #{source_file} > #{target_file}"
+ target_html = DOC_PATH/"#{File.basename(source_file, ".md")}.html"
+ safe_system "ronn --fragment --pipe --organization='Homebrew' --manual='brew' #{source_file} > #{target_html}"
+ target_man = TARGET_PATH/File.basename(source_file, ".md")
+ safe_system "ronn --roff --pipe --organization='Homebrew' --manual='brew' #{source_file} > #{target_man}"
end
system "man", target_file if ARGV.flag? "--verbose"