Skip to content
Snippets Groups Projects
Commit 72bc0570 authored by EricFromCanada's avatar EricFromCanada
Browse files

manpage: fixes for formatting

parent f784b710
No related branches found
No related tags found
No related merge requests found
Showing
with 30 additions and 26 deletions
......@@ -16,7 +16,7 @@ module Homebrew
def __cache_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`--cache` [<options>] [<formula|cask>]
`--cache` [<options>] [<formula>|<cask>]
Display Homebrew's download cache. See also `HOMEBREW_CACHE`.
......
......@@ -17,6 +17,7 @@ module Homebrew
Print the version numbers of Homebrew, Homebrew/homebrew-core and Homebrew/homebrew-cask
(if tapped) to standard output.
EOS
max_named 0
end
end
......
......@@ -20,12 +20,13 @@ module Homebrew
`brew analytics` [`state`]:
Display the current state of Homebrew's analytics.
`brew analytics` [`on`|`off`]:
`brew analytics` (`on`|`off`):
Turn Homebrew's analytics on or off respectively.
`brew analytics regenerate-uuid`:
Regenerate the UUID used for Homebrew's analytics.
EOS
max_named 1
end
end
......
......@@ -17,7 +17,8 @@ module Homebrew
EOS
switch "-n", "--dry-run",
description: "List what would be uninstalled, but do not actually uninstall anything."
named 0
max_named 0
end
end
......
......@@ -85,7 +85,6 @@ module Homebrew
}],
[:switch, "--keep-tmp", {
description: "Retain the temporary files created during installation.",
}],
[:switch, "--build-bottle", {
description: "Prepare the formula for eventual bottling during installation, skipping any " \
......@@ -125,7 +124,6 @@ module Homebrew
conflicts "--ignore-dependencies", "--only-dependencies"
conflicts "--build-from-source", "--build-bottle", "--force-bottle"
min_named :formula_or_cask
end
end
......
......@@ -15,7 +15,7 @@ module Homebrew
def list_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`list`, `ls` [<options>] [<formula|cask>]
`list`, `ls` [<options>] [<formula>|<cask>]
List all installed formulae and casks.
......
......@@ -28,8 +28,9 @@ module Homebrew
description: "Print only one commit."
flag "-n", "--max-count=",
description: "Print only a specified number of commits."
max_named 1
conflicts "-1", "--max-count"
max_named 1
end
end
......
......@@ -45,8 +45,8 @@ module Homebrew
}],
[:switch, "-i", "--interactive", {
description: "Download and patch <formula>, then open a shell. This allows the user to " \
"run `./configure --help` and otherwise determine how to turn the software " \
"package into a Homebrew package.",
"run `./configure --help` and otherwise determine how to turn the software " \
"package into a Homebrew package.",
}],
[:switch, "--force-bottle", {
description: "Install from a bottle if it exists for the current or newest version of " \
......@@ -75,7 +75,6 @@ module Homebrew
cask_options
conflicts "--build-from-source", "--force-bottle"
min_named :formula_or_cask
end
end
......
......@@ -47,8 +47,8 @@ module Homebrew
}],
[:switch, "-i", "--interactive", {
description: "Download and patch <formula>, then open a shell. This allows the user to "\
"run `./configure --help` and otherwise determine how to turn the software "\
"package into a Homebrew package.",
"run `./configure --help` and otherwise determine how to turn the software "\
"package into a Homebrew package.",
}],
[:switch, "--force-bottle", {
description: "Install from a bottle if it exists for the current or newest version of "\
......@@ -58,7 +58,6 @@ module Homebrew
description: "Fetch the upstream repository to detect if the HEAD installation of the "\
"formula is outdated. Otherwise, the repository's HEAD will only be checked for "\
"updates when a new stable or development version has been released.",
}],
[:switch, "--ignore-pinned", {
description: "Set a successful exit status even if pinned formulae are not upgraded.",
......
......@@ -40,6 +40,7 @@ module Homebrew
description: "Include all formulae that specify <formula> as `:optional` type dependency."
switch "--skip-recommended",
description: "Skip all formulae that specify <formula> as `:recommended` type dependency."
min_named :formula
end
end
......
......@@ -14,7 +14,7 @@ module Homebrew
def bump_cask_pr_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
`bump-cask-pr` [<options>] [<cask>]
`bump-cask-pr` [<options>] <cask>
Create a pull request to update <cask> with a new version.
......
......@@ -73,7 +73,7 @@ module Homebrew
depends_on: "--tag=",
description: "Specify the new git commit <revision> corresponding to the specified <tag>."
switch "-f", "--force",
description: "Ignore duplicate open PRs. Remove all mirrors if --mirror= was not specified."
description: "Ignore duplicate open PRs. Remove all mirrors if `--mirror` was not specified."
conflicts "--dry-run", "--write"
conflicts "--no-audit", "--strict"
......
......@@ -17,8 +17,8 @@ module Homebrew
Display out-of-date brew formulae and the latest version available.
Also displays whether a pull request has been opened with the URL.
EOS
flag "--limit=",
description: "Limit number of package results returned."
flag "--limit=",
description: "Limit number of package results returned."
switch :verbose
switch :debug
end
......
......@@ -16,6 +16,7 @@ module Homebrew
Display the source of <formula>.
EOS
named :formula
end
end
......
......@@ -27,14 +27,14 @@ module Homebrew
description: "Dispatch specified workflow (default: `dispatch-build-bottle.yml`)."
switch "--upload",
description: "Upload built bottles to Bintray."
min_named :formula
end
end
def dispatch_build_bottle
args = dispatch_build_bottle_args.parse
raise FormulaUnspecifiedError if args.named.empty?
odie "Must specify --macos option" unless args.macos
macos = begin
......
......@@ -30,6 +30,7 @@ module Homebrew
"comparison without factoring in the date)."
switch "--link",
description: "This is now done automatically by `brew update`."
max_named 0
end
end
......@@ -219,7 +220,7 @@ module Homebrew
def global_cask_options_manpage
lines = ["These options are applicable to subcommands accepting a `--cask` flag and all `cask` commands.\n"]
lines += Homebrew::CLI::Parser.global_cask_options.map do |_, long, description:, **|
generate_option_doc(nil, long, description)
generate_option_doc(nil, long.chomp("="), description)
end
lines.join("\n")
end
......
......@@ -24,8 +24,8 @@ module Homebrew
switch "--no-publish",
description: "Upload to Bintray, but don't publish."
hide_from_man_page!
min_named :formula
hide_from_man_page!
end
end
......
......@@ -21,9 +21,9 @@ module Homebrew
description: "Target tap repository (default: `homebrew/core`)."
flag "--with-label=",
description: "Pull requests must have this label."
comma_array "--without-labels=",
description: "Pull requests must not have these labels "\
"(default: `do not merge`, `new formula`, `automerge-skip`)."
comma_array "--without-labels",
description: "Pull requests must not have these labels (default: "\
"`do not merge`, `new formula`, `automerge-skip`, `linux-only`)."
switch "--without-approval",
description: "Pull requests do not require approval to be merged."
switch "--publish",
......
......@@ -62,8 +62,9 @@ module Homebrew
flag "--bintray-mirror=",
description: "Use the specified Bintray repository to automatically mirror stable URLs "\
"defined in the formulae (default: `mirror`)."
min_named 1
conflicts "--clean", "--autosquash"
min_named 1
end
end
......
......@@ -19,7 +19,6 @@ module Homebrew
sig { returns(CLI::Parser) }
def pull_args
Homebrew::CLI::Parser.new do
hide_from_man_page!
usage_banner <<~EOS
`pull` [<options>] <patch>
......@@ -43,6 +42,7 @@ module Homebrew
description: "Do not copy anything to the system clipboard."
min_named 1
hide_from_man_page!
end
end
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment