Module: Homebrew::Manpages Private

Defined in:
manpages.rb

Overview

This module is part of a private API. This module may only be used in the Homebrew/brew repository. Third parties should avoid using this module if possible, as it may be removed or changed without warning.

Helper functions for generating homebrew manual.

Class Method Summary collapse

Class Method Details

.build_man_page(quiet:) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
# File 'manpages.rb', line 28

def build_man_page(quiet:)
  template = (SOURCE_PATH/"brew.1.md.erb").read
  variables = OpenStruct.new

  variables[:commands] = generate_cmd_manpages(Commands.internal_commands_paths)
  variables[:developer_commands] = generate_cmd_manpages(Commands.internal_developer_commands_paths)
  variables[:official_external_commands] =
    generate_cmd_manpages(Commands.official_external_commands_paths(quiet: quiet))
  variables[:global_cask_options] = global_cask_options_manpage
  variables[:global_options] = global_options_manpage
  variables[:environment_variables] = env_vars_manpage

  readme = HOMEBREW_REPOSITORY/"README.md"
  variables[:lead] =
    readme.read[/(Homebrew's \[Project Leader.*\.)/, 1]
          .gsub(/\[([^\]]+)\]\([^)]+\)/, '\1')
  variables[:plc] =
    readme.read[/(Homebrew's \[Project Leadership Committee.*\.)/, 1]
          .gsub(/\[([^\]]+)\]\([^)]+\)/, '\1')
  variables[:tsc] =
    readme.read[/(Homebrew's \[Technical Steering Committee.*\.)/, 1]
          .gsub(/\[([^\]]+)\]\([^)]+\)/, '\1')
  variables[:maintainers] =
    readme.read[/(Homebrew's other current maintainers .*\.)/, 1]
          .gsub(/\[([^\]]+)\]\([^)]+\)/, '\1')
  variables[:alumni] =
    readme.read[/(Former maintainers .*\.)/, 1]
          .gsub(/\[([^\]]+)\]\([^)]+\)/, '\1')

  ERB.new(template, trim_mode: ">").result(variables.instance_eval { binding })
end

.cmd_comment_manpage_lines(cmd_path) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
# File 'manpages.rb', line 155

def cmd_comment_manpage_lines(cmd_path)
  comment_lines = cmd_path.read.lines.grep(/^#:/)
  return if comment_lines.empty?
  return if comment_lines.first.include?("@hide_from_man_page")

  lines = [format_usage_banner(comment_lines.first).chomp]
  comment_lines.slice(1..-1)
               .each do |line|
    line = line.slice(4..-2)
    unless line
      lines.last << "\n"
      next
    end

    # Omit the common global_options documented separately in the man page.
    next if line.match?(/--(debug|help|quiet|verbose) /)

    # Format one option or a comma-separated pair of short and long options.
    lines << line.gsub(/^ +(-+[a-z-]+), (-+[a-z-]+) +/, "* `\\1`, `\\2`:\n  ")
                 .gsub(/^ +(-+[a-z-]+) +/, "* `\\1`:\n  ")
  end
  lines.last << "\n"
  lines
end

.cmd_parser_manpage_lines(cmd_parser) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
# File 'manpages.rb', line 138

def cmd_parser_manpage_lines(cmd_parser)
  lines = [format_usage_banner(cmd_parser.usage_banner_text)]
  lines += cmd_parser.processed_options.map do |short, long, _, desc, hidden|
    next if hidden

    if long.present?
      next if Homebrew::CLI::Parser.global_options.include?([short, long, desc])
      next if Homebrew::CLI::Parser.global_cask_options.any? do |_, option, description:, **|
                [long, "#{long}="].include?(option) && description == desc
              end
    end

    generate_option_doc(short, long, desc)
  end.compact
  lines
end

.convert_man_page(markup, target) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
# File 'manpages.rb', line 65

def convert_man_page(markup, target)
  manual = target.basename(".1")
  organisation = "Homebrew"

  # Set the manpage date to the existing one if we're updating.
  # This avoids the only change being e.g. a new date.
  date = if target.extname == ".1" && target.exist?
    /"(\d{1,2})" "([A-Z][a-z]+) (\d{4})" "#{organisation}" "#{manual}"/ =~ target.read
    Date.parse("#{Regexp.last_match(1)} #{Regexp.last_match(2)} #{Regexp.last_match(3)}")
  else
    Date.today
  end
  date = date.strftime("%Y-%m-%d")

  shared_args = %W[
    --pipe
    --organization=#{organisation}
    --manual=#{target.basename(".1")}
    --date=#{date}
  ]

  format_flag, format_desc = target_path_to_format(target)

  puts "Writing #{format_desc} to #{target}"
  Utils.popen(["ronn", format_flag] + shared_args, "rb+") do |ronn|
    ronn.write markup
    ronn.close_write
    ronn_output = ronn.read
    odie "Got no output from ronn!" if ronn_output.blank?
    ronn_output = case format_flag
    when "--markdown"
      ronn_output.gsub(%r{<var>(.*?)</var>}, "*`\\1`*")
                 .gsub(/\n\n\n+/, "\n\n")
                 .gsub(/^(- `[^`]+`):/, "\\1") # drop trailing colons from definition lists
                 .gsub(/(?<=\n\n)([\[`].+):\n/, "\\1\n<br>") # replace colons with <br> on subcommands
    when "--roff"
      ronn_output.gsub(%r{<code>(.*?)</code>}, "\\fB\\1\\fR")
                 .gsub(%r{<var>(.*?)</var>}, "\\fI\\1\\fR")
                 .gsub(/(^\[?\\fB.+): /, "\\1\n    ")
    end
    target.atomic_write ronn_output
  end
end

.env_vars_manpageString

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



200
201
202
203
204
205
206
207
208
209
210
# File 'manpages.rb', line 200

def env_vars_manpage
  lines = Homebrew::EnvConfig::ENVS.flat_map do |env, hash|
    entry = "- `#{env}`:\n  <br>#{hash[:description]}\n"
    default = hash[:default_text]
    default ||= "`#{hash[:default]}`." if hash[:default]
    entry += "\n\n  *Default:* #{default}\n" if default

    entry
  end
  lines.join("\n")
end

.format_opt(opt) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



212
213
214
# File 'manpages.rb', line 212

def format_opt(opt)
  "`#{opt}`" unless opt.nil?
end

.format_usage_banner(usage_banner) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



224
225
226
# File 'manpages.rb', line 224

def format_usage_banner(usage_banner)
  usage_banner&.sub(/^(#: *\* )?/, "### ")
end

.generate_cmd_manpages(cmd_paths) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
# File 'manpages.rb', line 118

def generate_cmd_manpages(cmd_paths)
  man_page_lines = []

  # preserve existing manpage order
  cmd_paths.sort_by(&method(:sort_key_for_path))
           .each do |cmd_path|
    cmd_man_page_lines = if (cmd_parser = Homebrew::CLI::Parser.from_cmd_path(cmd_path))
      next if cmd_parser.hide_from_man_page

      cmd_parser_manpage_lines(cmd_parser).join
    else
      cmd_comment_manpage_lines(cmd_path)
    end

    man_page_lines << cmd_man_page_lines
  end

  man_page_lines.compact.join("\n")
end

.generate_option_doc(short, long, desc) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



216
217
218
219
220
221
222
# File 'manpages.rb', line 216

def generate_option_doc(short, long, desc)
  comma = (short && long) ? ", " : ""
  <<~EOS
    * #{format_opt(short)}#{comma}#{format_opt(long)}:
      #{desc}
  EOS
end

.global_cask_options_manpageString

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



181
182
183
184
185
186
187
188
# File 'manpages.rb', line 181

def global_cask_options_manpage
  lines = ["These options are applicable to the `install`, `reinstall`, and `upgrade` " \
           "subcommands with the `--cask` flag.\n"]
  lines += Homebrew::CLI::Parser.global_cask_options.map do |_, long, description:, **|
    generate_option_doc(nil, long.chomp("="), description)
  end
  lines.join("\n")
end

.global_options_manpageString

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



191
192
193
194
195
196
197
# File 'manpages.rb', line 191

def global_options_manpage
  lines = ["These options are applicable across multiple subcommands.\n"]
  lines += Homebrew::CLI::Parser.global_options.map do |short, long, desc|
    generate_option_doc(short, long, desc)
  end
  lines.join("\n")
end

.regenerate_man_pages(quiet:) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



19
20
21
22
23
24
25
26
# File 'manpages.rb', line 19

def regenerate_man_pages(quiet:)
  Homebrew.install_bundler_gems!

  markup = build_man_page(quiet: quiet)
  convert_man_page(markup, TARGET_DOC_PATH/"Manpage.md")
  markup = I18n.transliterate(markup, locale: :en)
  convert_man_page(markup, TARGET_MAN_PATH/"brew.1")
end

.sort_key_for_path(path) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



60
61
62
63
# File 'manpages.rb', line 60

def sort_key_for_path(path)
  # Options after regular commands (`~` comes after `z` in ASCII table).
  path.basename.to_s.sub(/\.(rb|sh)$/, "").sub(/^--/, "~~")
end

.target_path_to_format(target) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



109
110
111
112
113
114
115
116
# File 'manpages.rb', line 109

def target_path_to_format(target)
  case target.basename
  when /\.md$/    then ["--markdown", "markdown"]
  when /\.\d$/    then ["--roff", "man page"]
  else
    odie "Failed to infer output format from '#{target.basename}'."
  end
end