From 9b36e8377142241218cb472dcaf64561f70b96e9 Mon Sep 17 00:00:00 2001 From: "Tim D. Smith" <git@tim-smith.us> Date: Tue, 28 Jun 2016 08:08:12 -0700 Subject: [PATCH] Add magic token to hide commands from man page Closes #402. --- Library/Homebrew/cmd/help.rb | 5 +++-- Library/Homebrew/cmd/man.rb | 2 +- Library/Homebrew/cmd/tests.rb | 1 + 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/Library/Homebrew/cmd/help.rb b/Library/Homebrew/cmd/help.rb index 7cb414ca1b..ac5fce5b75 100644 --- a/Library/Homebrew/cmd/help.rb +++ b/Library/Homebrew/cmd/help.rb @@ -91,8 +91,9 @@ module Homebrew line.slice(2..-1). sub(/^ \* /, "#{Tty.highlight}brew#{Tty.reset} "). gsub(/`(.*?)`/, "#{Tty.highlight}\\1#{Tty.reset}"). - gsub(/<(.*?)>/, "#{Tty.em}\\1#{Tty.reset}") - end.join + gsub(/<(.*?)>/, "#{Tty.em}\\1#{Tty.reset}"). + gsub("@hide_from_man_page", "") + end.join.strip end end end diff --git a/Library/Homebrew/cmd/man.rb b/Library/Homebrew/cmd/man.rb index e23313be38..d704d46a10 100644 --- a/Library/Homebrew/cmd/man.rb +++ b/Library/Homebrew/cmd/man.rb @@ -51,7 +51,7 @@ module Homebrew map { |line| line.slice(2..-1) }. join }. - reject { |s| s.strip.empty? } + reject { |s| s.strip.empty? || s.include?("@hide_from_man_page") } variables[:maintainers] = (HOMEBREW_REPOSITORY/"README.md"). read[/Homebrew's current maintainers are (.*)\./, 1]. diff --git a/Library/Homebrew/cmd/tests.rb b/Library/Homebrew/cmd/tests.rb index 58e90cec71..71cfcde18e 100644 --- a/Library/Homebrew/cmd/tests.rb +++ b/Library/Homebrew/cmd/tests.rb @@ -1,3 +1,4 @@ +#: @hide_from_man_page #: * `tests` [`-v`] [`--coverage`] [`--generic`] [`--no-compat`] [`--only=`<test_script/test_method>] [`--seed` <seed>] [`--trace`]: #: Run Homebrew's unit and integration tests. -- GitLab