refactor(cli): Switch help text to functions

Author: epage

src/cli/help.rs

@@ -1,53 +1,66 @@
-pub(crate) static RUSTUP_HELP: &str = r"Discussion:
+pub(crate) fn rustup_help() -> &'static str {
+    r"Discussion:
     Rustup installs The Rust Programming Language from the official
     release channels, enabling you to easily switch between stable,
     beta, and nightly compilers and keep them updated. It makes
     cross-compiling simpler with binary builds of the standard library
     for common platforms.
 
     If you are new to Rust consider running `rustup doc --book` to
-    learn Rust.";
+    learn Rust."
+}
 
-pub(crate) static SHOW_HELP: &str = r"Discussion:
+pub(crate) fn show_help() -> &'static str {
+    r"Discussion:
     Shows the name of the active toolchain and the version of `rustc`.
 
     If the active toolchain has installed support for additional
     compilation targets, then they are listed as well.
 
     If there are multiple toolchains installed then all installed
-    toolchains are listed as well.";
+    toolchains are listed as well."
+}
 
-pub(crate) static SHOW_ACTIVE_TOOLCHAIN_HELP: &str = r"Discussion:
+pub(crate) fn show_active_toolchain_help() -> &'static str {
+    r"Discussion:
     Shows the name of the active toolchain.
 
     This is useful for figuring out the active tool chain from
     scripts.
 
     You should use `rustc --print sysroot` to get the sysroot, or
-    `rustc --version` to get the toolchain version.";
+    `rustc --version` to get the toolchain version."
+}
 
-pub(crate) static UPDATE_HELP: &str = r"Discussion:
+pub(crate) fn update_help() -> &'static str {
+    r"Discussion:
     With no toolchain specified, the `update` command updates each of
     the installed toolchains from the official release channels, then
     updates rustup itself.
 
     If given a toolchain argument then `update` updates that
-    toolchain, the same as `rustup toolchain install`.";
+    toolchain, the same as `rustup toolchain install`."
+}
 
-pub(crate) static INSTALL_HELP: &str = r"Discussion:
+pub(crate) fn install_help() -> &'static str {
+    r"Discussion:
     Installs a specific rust toolchain.
 
-    The 'install' command is an alias for 'rustup update <toolchain>'.";
+    The 'install' command is an alias for 'rustup update <toolchain>'."
+}
 
-pub(crate) static DEFAULT_HELP: &str = r"Discussion:
+pub(crate) fn default_help() -> &'static str {
+    r"Discussion:
     Sets the default toolchain to the one specified. If the toolchain
-    is not already installed then it is installed first.";
+    is not already installed then it is installed first."
+}
 
-pub(crate) static TOOLCHAIN_HELP: &str = r"Discussion:
+pub(crate) fn toolchain_help() -> &'static str {
+    r"Discussion:
     Many `rustup` commands deal with *toolchains*, a single
     installation of the Rust compiler. `rustup` supports multiple
     types of toolchains. The most basic track the official release
-    channels: 'stable', 'beta' and 'nightly'; but `rustup` can also
+    channels: 'stable', 'beta' and 'nightly'} but `rustup` can also
     install specific toolchains from the official archives, toolchains for
     alternate host platforms, and from local builds ('custom toolchains').
 
@@ -85,9 +98,11 @@ pub(crate) static TOOLCHAIN_HELP: &str = r"Discussion:
 
     rustup can also manage symlinked local toolchain builds, which are
     often used for developing Rust itself. For more information see
-    `rustup toolchain help link`.";
+    `rustup toolchain help link`."
+}
 
-pub(crate) static TOOLCHAIN_LINK_HELP: &str = r"Discussion:
+pub(crate) fn toolchain_link_help() -> &'static str {
+    r"Discussion:
     'toolchain' is the custom name to be assigned to the new toolchain.
     Any name is permitted as long as:
     - it does not include '/' or '\' except as the last character
@@ -106,9 +121,11 @@ pub(crate) static TOOLCHAIN_LINK_HELP: &str = r"Discussion:
         $ rustup override set latest-stage1
 
     If you now compile a crate in the current directory, the custom
-    toolchain 'latest-stage1' will be used.";
+    toolchain 'latest-stage1' will be used."
+}
 
-pub(crate) static OVERRIDE_HELP: &str = r"Discussion:
+pub(crate) fn override_help() -> &'static str {
+    r"Discussion:
     Overrides configure Rustup to use a specific toolchain when
     running in a specific directory.
 
@@ -127,16 +144,20 @@ pub(crate) static OVERRIDE_HELP: &str = r"Discussion:
 
     To see the active toolchain use `rustup show`. To remove the
     override and use the default toolchain again, `rustup override
-    unset`.";
+    unset`."
+}
 
-pub(crate) static OVERRIDE_UNSET_HELP: &str = r"Discussion:
+pub(crate) fn override_unset_help() -> &'static str {
+    r"Discussion:
     If `--path` argument is present, removes the override toolchain
     for the specified directory. If `--nonexistent` argument is
     present, removes the override toolchain for all nonexistent
     directories. Otherwise, removes the override toolchain for the
-    current directory.";
+    current directory."
+}
 
-pub(crate) static RUN_HELP: &str = r"Discussion:
+pub(crate) fn run_help() -> &'static str {
+    r"Discussion:
     Configures an environment to use the given toolchain and then runs
     the specified program. The command may be any program, not just
     rustc or cargo. This can be used for testing arbitrary toolchains
@@ -149,16 +170,20 @@ pub(crate) static RUN_HELP: &str = r"Discussion:
 
         $ cargo +nightly build
 
-        $ rustup run nightly cargo build";
+        $ rustup run nightly cargo build"
+}
 
-pub(crate) static DOC_HELP: &str = r"Discussion:
+pub(crate) fn doc_help() -> &'static str {
+    r"Discussion:
     Opens the documentation for the currently active toolchain with
     the default browser.
 
     By default, it opens the documentation index. Use the various
-    flags to open specific pieces of documentation.";
+    flags to open specific pieces of documentation."
+}
 
-pub(crate) static COMPLETIONS_HELP: &str = r"Discussion:
+pub(crate) fn completions_help() -> &'static str {
+    r"Discussion:
     Enable tab completion for Bash, Fish, Zsh, or PowerShell
     The script is output on `stdout`, allowing one to re-direct the
     output to the file of their choosing. Where you place the file
@@ -209,7 +234,7 @@ pub(crate) static COMPLETIONS_HELP: &str = r"Discussion:
     own to this list.
 
     Adding a custom directory is often the safest bet if you are
-    unsure of which directory to use. First create the directory; for
+    unsure of which directory to use. First create the directory} for
     this example we'll create a hidden directory inside our `$HOME`
     directory:
 
@@ -276,22 +301,33 @@ pub(crate) static COMPLETIONS_HELP: &str = r"Discussion:
 
     Zsh:
 
-        $ rustup completions zsh cargo > ~/.zfunc/_cargo";
+        $ rustup completions zsh cargo > ~/.zfunc/_cargo"
+}
 
-pub(crate) static OFFICIAL_TOOLCHAIN_ARG_HELP: &str = "Toolchain name, such as 'stable', 'nightly', \
+pub(crate) fn official_toolchain_arg_help() -> &'static str {
+    "Toolchain name, such as 'stable', 'nightly', \
                                        or '1.8.0'. For more information see `rustup \
-                                       help toolchain`";
-pub(crate) static RESOLVABLE_LOCAL_TOOLCHAIN_ARG_HELP: &str = "Toolchain name, such as 'stable', 'nightly', \
+                                       help toolchain`"
+}
+pub(crate) fn resolvable_local_toolchain_arg_help() -> &'static str {
+    "Toolchain name, such as 'stable', 'nightly', \
                                        '1.8.0', or a custom toolchain name, or an absolute path. For more \
-                                       information see `rustup help toolchain`";
-pub(crate) static RESOLVABLE_TOOLCHAIN_ARG_HELP: &str = "Toolchain name, such as 'stable', 'nightly', \
+                                       information see `rustup help toolchain`"
+}
+pub(crate) fn resolvable_toolchain_arg_help() -> &'static str {
+    "Toolchain name, such as 'stable', 'nightly', \
                                        '1.8.0', or a custom toolchain name. For more information see `rustup \
-                                       help toolchain`";
-pub(crate) static MAYBE_RESOLVABLE_TOOLCHAIN_ARG_HELP: &str = "'none', a toolchain name, such as 'stable', 'nightly', \
+                                       help toolchain`"
+}
+pub(crate) fn maybe_resolvable_toolchain_arg_help() -> &'static str {
+    "'none', a toolchain name, such as 'stable', 'nightly', \
                                        '1.8.0', or a custom toolchain name. For more information see `rustup \
-                                       help toolchain`";
+                                       help toolchain`"
+}
 
-pub(crate) static TOPIC_ARG_HELP: &str = "Topic such as 'core', 'fn', 'usize', 'eprintln!', \
+pub(crate) fn topic_arg_help() -> &'static str {
+    "Topic such as 'core', 'fn', 'usize', 'eprintln!', \
                                    'core::arch', 'alloc::format!', 'std::fs', \
                                    'std::fs::read_dir', 'std::io::Bytes', \
-                                   'std::iter::Sum', 'std::io::error::Result' etc...";
+                                   'std::iter::Sum', 'std::io::error::Result' etc..."
+}