summaryrefslogtreecommitdiff
path: root/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/help_command.ex
Commit message (Collapse)AuthorAgeFilesLines
* Switch to Mozilla Public License 2.0 (MPL 2.0)dcorbacho2020-07-111-12/+3
|
* Re-categorize some rabbitmq-diagnostics commandsMichael Klishin2020-07-051-1/+1
| | | | | | | | For a couple of reasons: * The Observability, Monitoring and Health Checks group has grown too large * Some commands in it clearly have to do with exploring effective node or CLI tool configuration, not its dynamically changing operational state
* Make --help, help usage help messages consistentMichael Klishin2020-06-291-18/+38
| | | | | | | | | | | | | | | | | * `help` printed an "Error:" at the top for no reason * `help [command]` with a non-existent command did not offer a suggestion like an attempt to invoke a non-existent command would * Exit codes were not consistent * `help --list-commands` had line break issues With this change, * `help` is consistent with --help * `help [command]` is consistent with `[command] --help` * If a command is not found, either during the execution flow or `help [commnad]`, we consistently attempt a Jaro distance suggestion * Successful or effectively successful exits from the `help` command do not produce any error messages at the top
* Drive by change: help command should be available in all scopesMichael Klishin2020-04-221-1/+1
| | | | | | Currently 'rabbitmq-upgrade --help' works as expected but 'rabbitmq-upgrade help' exists with the same message but an error exit code.
* Update copyright (year 2020)Jean-Sébastien Pédron2020-03-101-1/+1
|
* (c) bumpMichael Klishin2019-12-291-1/+1
|
* Add erlang formatter function headsLuke Bakken2019-10-211-1/+1
| | | | Fixes #383
* Recompile all regexes.Daniil Fedotov2019-05-071-3/+5
| | | | | Compiled regexes are endianness-specific. To run on any endianness systems we need to recompile them in runtime.
* Extract Core.ANSI from status and help commandsMichael Klishin2019-04-161-4/+2
|
* Clarify that not every command supports every formatterMichael Klishin2019-04-051-1/+2
|
* Rename functionMichael Klishin2019-03-311-2/+2
|
* Correctly format blank command descriptionMichael Klishin2019-03-261-1/+4
| | | | | Don't print a trailing dot and a new line break, that is confusing and doesn't look great.
* A typoMichael Klishin2019-03-261-2/+2
| | | | <3 <3 <3 dogs
* Recommend doc guides in --help for more commandsMichael Klishin2019-03-261-1/+1
|
* A way for commands to provide a list of relevant doc guidesMichael Klishin2019-03-261-0/+14
| | | | in the help message.
* Rework how command-specific options are displayed in helpMichael Klishin2019-03-261-8/+23
| | | | | | Per recommendation from @dumbbell. usage_addition/0 return format per discussion with @dcorbacho, @hairyhum, @lukebakken.
* URL CleanupSpring Operator2019-03-201-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This commit updates URLs to prefer the https protocol. Redirects are not followed to avoid accidentally expanding intentionally shortened URLs (i.e. if using a URL shortener). # HTTP URLs that Could Not Be Fixed These URLs were unable to be fixed. Please review them to see if they can be manually resolved. * http://blog.listincomprehension.com/search/label/procket (200) with 1 occurrences could not be migrated: ([https](https://blog.listincomprehension.com/search/label/procket) result ClosedChannelException). * http://dozzie.jarowit.net/trac/wiki/TOML (200) with 1 occurrences could not be migrated: ([https](https://dozzie.jarowit.net/trac/wiki/TOML) result SSLHandshakeException). * http://dozzie.jarowit.net/trac/wiki/subproc (200) with 1 occurrences could not be migrated: ([https](https://dozzie.jarowit.net/trac/wiki/subproc) result SSLHandshakeException). * http://e2project.org (200) with 1 occurrences could not be migrated: ([https](https://e2project.org) result AnnotatedConnectException). * http://erlang.org/doc/reference_manual/distributed.html (200) with 1 occurrences could not be migrated: ([https](https://erlang.org/doc/reference_manual/distributed.html) result ConnectTimeoutException). * http://nitrogenproject.com/ (200) with 2 occurrences could not be migrated: ([https](https://nitrogenproject.com/) result ConnectTimeoutException). * http://proper.softlab.ntua.gr (200) with 1 occurrences could not be migrated: ([https](https://proper.softlab.ntua.gr) result SSLHandshakeException). * http://yaws.hyber.org (200) with 1 occurrences could not be migrated: ([https](https://yaws.hyber.org) result AnnotatedConnectException). * http://choven.ca (503) with 1 occurrences could not be migrated: ([https](https://choven.ca) result ConnectTimeoutException). # Fixed URLs ## Fixed But Review Recommended These URLs were fixed, but the https status was not OK. However, the https status was the same as the http request or http redirected to an https URL, so they were migrated. Your review is recommended. * http://fixprotocol.org/ (301) with 1 occurrences migrated to: https://fixtrading.org ([https](https://fixprotocol.org/) result SSLHandshakeException). * http://erldb.org (UnknownHostException) with 1 occurrences migrated to: https://erldb.org ([https](https://erldb.org) result UnknownHostException). * http://elixir-lang.org/docs/stable/elixir/OptionParser.html (301) with 1 occurrences migrated to: https://elixir-lang.org/docs/stable/elixir/OptionParser.html ([https](https://elixir-lang.org/docs/stable/elixir/OptionParser.html) result 404). * http://elixir-lang.org/docs/stable/elixir/Stream.html (301) with 1 occurrences migrated to: https://elixir-lang.org/docs/stable/elixir/Stream.html ([https](https://elixir-lang.org/docs/stable/elixir/Stream.html) result 404). ## Fixed Success These URLs were switched to an https URL with a 2xx status. While the status was successful, your review is still recommended. * http://cloudi.org/ with 27 occurrences migrated to: https://cloudi.org/ ([https](https://cloudi.org/) result 200). * http://elixir-lang.org with 1 occurrences migrated to: https://elixir-lang.org ([https](https://elixir-lang.org) result 200). * http://elixir-lang.org/ with 2 occurrences migrated to: https://elixir-lang.org/ ([https](https://elixir-lang.org/) result 200). * http://elixir-lang.org/getting-started/typespecs-and-behaviours.html with 1 occurrences migrated to: https://elixir-lang.org/getting-started/typespecs-and-behaviours.html ([https](https://elixir-lang.org/getting-started/typespecs-and-behaviours.html) result 200). * http://elixir-lang.org/install.html with 1 occurrences migrated to: https://elixir-lang.org/install.html ([https](https://elixir-lang.org/install.html) result 200). * http://erlware.org/ with 1 occurrences migrated to: https://erlware.org/ ([https](https://erlware.org/) result 200). * http://inaka.github.io/cowboy-trails/ with 1 occurrences migrated to: https://inaka.github.io/cowboy-trails/ ([https](https://inaka.github.io/cowboy-trails/) result 200). * http://ninenines.eu with 6 occurrences migrated to: https://ninenines.eu ([https](https://ninenines.eu) result 200). * http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html with 1 occurrences migrated to: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html ([https](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) result 200). * http://www.actordb.com/ with 2 occurrences migrated to: https://www.actordb.com/ ([https](https://www.actordb.com/) result 200). * http://www.cs.kent.ac.uk/projects/wrangler/Home.html with 1 occurrences migrated to: https://www.cs.kent.ac.uk/projects/wrangler/Home.html ([https](https://www.cs.kent.ac.uk/projects/wrangler/Home.html) result 200). * http://www.rebar3.org with 1 occurrences migrated to: https://www.rebar3.org ([https](https://www.rebar3.org) result 200). * http://contributor-covenant.org with 1 occurrences migrated to: https://contributor-covenant.org ([https](https://contributor-covenant.org) result 301). * http://contributor-covenant.org/version/1/3/0/ with 1 occurrences migrated to: https://contributor-covenant.org/version/1/3/0/ ([https](https://contributor-covenant.org/version/1/3/0/) result 301). * http://inaka.github.com/apns4erl with 1 occurrences migrated to: https://inaka.github.com/apns4erl ([https](https://inaka.github.com/apns4erl) result 301). * http://inaka.github.com/edis/ with 1 occurrences migrated to: https://inaka.github.com/edis/ ([https](https://inaka.github.com/edis/) result 301). * http://lasp-lang.org/ with 1 occurrences migrated to: https://lasp-lang.org/ ([https](https://lasp-lang.org/) result 301). * http://rabbitmq.com/documentation.html with 1 occurrences migrated to: https://rabbitmq.com/documentation.html ([https](https://rabbitmq.com/documentation.html) result 301). * http://saleyn.github.com/erlexec with 1 occurrences migrated to: https://saleyn.github.com/erlexec ([https](https://saleyn.github.com/erlexec) result 301). * http://www.mozilla.org/MPL/ with 290 occurrences migrated to: https://www.mozilla.org/MPL/ ([https](https://www.mozilla.org/MPL/) result 301). * http://zhongwencool.github.io/observer_cli with 1 occurrences migrated to: https://zhongwencool.github.io/observer_cli ([https](https://zhongwencool.github.io/observer_cli) result 301).
* Reduce generic options section per discussion in #333Michael Klishin2019-03-191-21/+3
| | | | | The section on node names has been moved to https://www.rabbitmq.com/cli.html#node-names (not yet live).
* Reduce general options sectionMichael Klishin2019-03-181-25/+9
| | | | | | | | | | | * Only keep [--timeout <n>] but not a separate section for commands that support timeouts. * Replace a separate virtual host section with a general option. This option doesn't really need a detailed explanation. * Replace a separate --quiet/--silent section with a general option. This option doesn't really need a detailed explanation. Per discussion with @gerhard and @acogoluegnes.
* Document more command-specific arguments and switchesMichael Klishin2019-03-181-0/+5
|
* Global options: mention --formatter=pretty_tableMichael Klishin2019-03-171-1/+1
|
* Do not indent lines in usage_additionalMichael Klishin2019-03-171-3/+3
| | | | | | We eliminated indentation in other sections because it is too painful to get aligned for command author.
* Rework command-specific helpMichael Klishin2019-03-171-69/+91
| | | | | | | | | | | | | * Display command-specific options first instead of generic at the top * Include one line command synopsis from --list-commands in the command-specific message * List timeout in a separate section. It doesn't integrate very well with either command-specific or general section * Format section headings as H2s in Markdown, this makes them stand out * Assorted small formatting changes * Update tests to be less fragile to copywriting changes
* Help command descriptions, cosmeticsMichael Klishin2019-03-171-8/+11
|
* Correctly format management_agent and other multi-segment plugin namesMichael Klishin2019-03-161-1/+4
| | | | | Without this management_agent failed to be formatted causing an ugly looking exception in --help.
* New command group: replicationMichael Klishin2019-02-211-0/+3
|
* Improve formatting of protocol plugin help sectionsMichael Klishin2019-02-211-2/+26
|
* Combine virtual host management, limits, tracing into a single groupMichael Klishin2019-02-211-12/+8
|
* Command groups: naming, rearrangingMichael Klishin2019-02-211-19/+19
|
* Support custom help sections.Daniil Fedotov2019-02-141-3/+5
|
* Formatting of the help messageDaniil Fedotov2019-02-141-6/+10
|
* Make help sections and descriptions similar to man page.Daniil Fedotov2019-02-141-9/+19
|
* Cleanup help command. Support plugin sections in command list.Daniil Fedotov2019-02-111-104/+61
|
* More command descriptions.Daniil Fedotov2019-02-081-1/+1
|
* A new way to display basic usage.Daniil Fedotov2019-02-081-36/+131
| | | | | | | | | | | | Do not show additional parameters info. List commands as names and descriptions. Group commands in sections. New behaviour callbacks: help_section/0 - atom name of a group to put command to. Default is :other description/0 - single line description of the command. Printed in the commands list Sections ans descriptions are WIP.
* Reuse existing modules more, rearrange functionsMichael Klishin2019-02-041-5/+5
|
* Help message copywritingMichael Klishin2019-01-311-2/+2
|
* Mention --help in the global option sectionMichael Klishin2019-01-311-0/+1
|
* Make it possible to get command help by typing 'rabbitmqctl mycommand --help'Daniil Fedotov2019-01-301-6/+8
| | | | | | | Add a new default switch `help` Add an alias `?` Make rabbitmqctl display command help if this option is true for known commands.
* Format with `gmake format`Michael Klishin2019-01-301-54/+79
|
* RefactoringMichael Klishin2019-01-231-1/+1
|
* Update (c) yearMichael Klishin2019-01-201-1/+1
|
* Document --no-table-headersLuke Bakken2018-11-191-4/+12
| | | | | | | | | | Fixes #274 Switch no_table_headers to table_headers update tests Integrate --silent
* Reduce code footprint on aliasesAyanda Dube2018-07-231-3/+1
|
* Whitespace changesLuke Bakken2018-03-081-1/+1
| | | | See #236
* Show timeout in help messages only for commands supporting timeout.Daniil Fedotov2018-03-071-47/+54
| | | | | | | Removed timeout from default parsing options. Now every command has to specify timeout in it's own switches. If a command has timeout in switches - there will be help displayed for this option in usage output.
* Do not show timeout option for rabbitmq-plugins tool.Daniil Fedotov2018-03-071-27/+31
| | | | The rabbitmq-plugins tool does not respect timeout option.
* Optimise some commands by not starting erlang distributionDaniil Fedotov2017-12-071-0/+2
|
* Remove -l alias from help_command. It iss conflicting with default aliasDaniil Fedotov2017-08-181-1/+0
|
* Support Elixir-1.5.0-rc.0Daniil Fedotov2017-06-261-3/+2
|
View Lorry Controller Status