aboutsummaryrefslogtreecommitdiffstats
path: root/Library/Homebrew
diff options
context:
space:
mode:
authorMartin Afanasjew2016-04-17 05:34:41 +0200
committerMartin Afanasjew2016-04-17 20:43:27 +0200
commitfeb1e75b615d8ec10c06a1b8070fca77c5bc6334 (patch)
tree817b25cad05090d80a55564d72cce49d10294d63 /Library/Homebrew
parent3680c4667f1a47000c0152ca34bc3af7c41825ac (diff)
downloadbrew-feb1e75b615d8ec10c06a1b8070fca77c5bc6334.tar.bz2
manpages: add editing instructions to ERB template
Closes #102. Signed-off-by: Martin Afanasjew <martin@afanasjew.de>
Diffstat (limited to 'Library/Homebrew')
-rw-r--r--Library/Homebrew/manpages/brew.1.md.erb11
1 files changed, 11 insertions, 0 deletions
diff --git a/Library/Homebrew/manpages/brew.1.md.erb b/Library/Homebrew/manpages/brew.1.md.erb
index 5fc1d7e6d..f5d573321 100644
--- a/Library/Homebrew/manpages/brew.1.md.erb
+++ b/Library/Homebrew/manpages/brew.1.md.erb
@@ -1,3 +1,14 @@
+<%
+# To make changes to this man page:
+#
+# - For changes to a specific command (appears in the `COMMANDS` section):
+# - Edit the top comment in `Library/Homebrew/cmd/<command>.{rb,sh}`.
+# - Make sure to use the line prefix `#:` for the comments to be recognized as
+# documentation. If in doubt, compare with already documented commands.
+# - For other changes: Edit this file.
+#
+# When done, regenerate the man page and its HTML version by running `brew man`.
+%>
brew(1) -- The missing package manager for OS X
===============================================