Remove cask from man brew.

This commit is contained in:
Mike McQuaid 2020-11-25 09:37:21 +00:00
parent 3c2ec1c60f
commit b484f70572
No known key found for this signature in database
GPG Key ID: 48A898132FD8EE70
5 changed files with 10 additions and 50 deletions

View File

@ -61,6 +61,7 @@ module Cask
Cmd::Doctor => "brew doctor --verbose", Cmd::Doctor => "brew doctor --verbose",
Cmd::Edit => "brew edit [--cask]", Cmd::Edit => "brew edit [--cask]",
Cmd::Fetch => "brew fetch [--cask]", Cmd::Fetch => "brew fetch [--cask]",
Cmd::Help => "brew help",
Cmd::Home => "brew home", Cmd::Home => "brew home",
Cmd::Info => "brew info [--cask]", Cmd::Info => "brew info [--cask]",
Cmd::Install => "brew install [--cask]", Cmd::Install => "brew install [--cask]",
@ -73,26 +74,6 @@ module Cask
Cmd::Zap => "brew upgrade --zap [--cask]", Cmd::Zap => "brew upgrade --zap [--cask]",
}.freeze }.freeze
sig { returns(String) }
def self.description
max_command_length = Cmd.commands.map(&:length).max
command_lines = Cmd.command_classes
.select(&:visible?)
.reject { |command| DEPRECATED_COMMANDS.key?(command) }
.map do |klass|
" - #{"`#{klass.command_name}`".ljust(max_command_length + 2)} #{klass.short_description}\n"
end
<<~EOS
Homebrew Cask provides a friendly CLI workflow for the administration of macOS applications distributed as binaries.
Commands:
#{command_lines.join}
See also: `man brew`
EOS
end
def self.parser(&block) def self.parser(&block)
Homebrew::CLI::Parser.new do Homebrew::CLI::Parser.new do
if block if block
@ -101,7 +82,9 @@ module Cask
usage_banner <<~EOS usage_banner <<~EOS
`cask` <command> [<options>] [<cask>] `cask` <command> [<options>] [<cask>]
#{Cmd.description} Homebrew Cask provides a friendly CLI workflow for the administration of macOS applications distributed as binaries.
See also: `man brew`
EOS EOS
end end

View File

@ -100,8 +100,11 @@ module Commands
cmds.sort cmds.sort
end end
def internal_commands_paths def internal_commands_paths(cask: true)
find_commands HOMEBREW_CMD_PATH cmds = find_commands HOMEBREW_CMD_PATH
# can be removed when cask commands are removed and no longer odeprecated/odisabled
cmds.delete(HOMEBREW_CMD_PATH/"cask.rb") unless cask
cmds
end end
def internal_developer_commands_paths def internal_developer_commands_paths

View File

@ -67,7 +67,7 @@ module Homebrew
template = (SOURCE_PATH/"brew.1.md.erb").read template = (SOURCE_PATH/"brew.1.md.erb").read
variables = OpenStruct.new variables = OpenStruct.new
variables[:commands] = generate_cmd_manpages(Commands.internal_commands_paths) variables[:commands] = generate_cmd_manpages(Commands.internal_commands_paths(cask: false))
variables[:developer_commands] = generate_cmd_manpages(Commands.internal_developer_commands_paths) variables[:developer_commands] = generate_cmd_manpages(Commands.internal_developer_commands_paths)
variables[:official_external_commands] = variables[:official_external_commands] =
generate_cmd_manpages(Commands.official_external_commands_paths(quiet: quiet)) generate_cmd_manpages(Commands.official_external_commands_paths(quiet: quiet))

View File

@ -65,17 +65,6 @@ Uninstall formulae that were only installed as a dependency of another formula a
* `-n`, `--dry-run`: * `-n`, `--dry-run`:
List what would be uninstalled, but do not actually uninstall anything. List what would be uninstalled, but do not actually uninstall anything.
### `cask` *`command`* [*`options`*] [*`cask`*]
Homebrew Cask provides a friendly CLI workflow for the administration of macOS applications distributed as binaries.
Commands:
- `help`
<br>Print help for `cask` commands.
See also: `man brew`
### `cleanup` [*`options`*] [*`formula`*|*`cask`*] ### `cleanup` [*`options`*] [*`formula`*|*`cask`*]
Remove stale lock files and outdated downloads for all formulae and casks, Remove stale lock files and outdated downloads for all formulae and casks,

View File

@ -60,21 +60,6 @@ Uninstall formulae that were only installed as a dependency of another formula a
\fB\-n\fR, \fB\-\-dry\-run\fR \fB\-n\fR, \fB\-\-dry\-run\fR
List what would be uninstalled, but do not actually uninstall anything\. List what would be uninstalled, but do not actually uninstall anything\.
. .
.SS "\fBcask\fR \fIcommand\fR [\fIoptions\fR] [\fIcask\fR]"
Homebrew Cask provides a friendly CLI workflow for the administration of macOS applications distributed as binaries\.
.
.P
Commands:
.
.TP
\fBhelp\fR
.
.br
Print help for \fBcask\fR commands\.
.
.P
See also: \fBman brew\fR
.
.SS "\fBcleanup\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR]" .SS "\fBcleanup\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR]"
Remove stale lock files and outdated downloads for all formulae and casks, and remove old versions of installed formulae\. If arguments are specified, only do this for the given formulae and casks\. Removes all downloads more than 120 days old\. This can be adjusted with \fBHOMEBREW_CLEANUP_MAX_AGE_DAYS\fR\. Remove stale lock files and outdated downloads for all formulae and casks, and remove old versions of installed formulae\. If arguments are specified, only do this for the given formulae and casks\. Removes all downloads more than 120 days old\. This can be adjusted with \fBHOMEBREW_CLEANUP_MAX_AGE_DAYS\fR\.
. .