docs: Normalize quoting for option references

Use single quotes in all about and help strings.

Author: jpgrayson

src/cmd/branch.rs

@@ -150,8 +150,8 @@ fn make() -> clap::Command {
                 .long_about(
                     "Delete a branch.\n\
                      \n\
-                     The branch will not be deleted if there are any patches remaining unless \
-                     the --force option is provided.\n\
+                     The branch will not be deleted if there are any patches remaining \
+                     unless the '--force' option is provided.\n\
                      \n\
                      A protected branch may not be deleted; it must be unprotected first.",
                 )
@@ -175,7 +175,7 @@ fn make() -> clap::Command {
                 .about("Remove StGit patch stack from branch")
                 .long_about(
                     "Remove StGit patch stack from branch. The operation will be refused if \
-                     any patches remain, unless the --force option is provided.\n\
+                     any patches remain, unless the '--force' option is provided.\n\
                      \n\
                      A protected branch will not be cleaned up; it must be unprotected first.\n\
                      \n\

src/cmd/completion/man.rs

@@ -20,7 +20,7 @@ pub(super) fn command() -> clap::Command {
              other output formats.\n\
              \n\
              One file is generated for each `stg` command. The output directory \
-             defaults to the current directory, but may be specified with `--output`. \
+             defaults to the current directory, but may be specified with '--output'. \
              The output files are named `stg-<command>.txt`.",
         )
         .arg(

src/cmd/email/format.rs

@@ -24,7 +24,7 @@ pub(super) fn command() -> clap::Command {
              email's body.\n\
              \n\
              The patches to format may be specified as individual patch names or patch \
-             ranges of the form 'p0..p3', or --all may be used to format all applied \
+             ranges of the form 'p0..p3', or '--all' may be used to format all applied \
              patches. Note that the specified patches must be contiguous within the \
              patch series.\n\
              \n\
@@ -34,13 +34,13 @@ pub(super) fn command() -> clap::Command {
              all the email files individually.\n\
              \n\
              A cover letter template may also be generated by specifying \
-             --cover-letter. A cover letter is recommended when sending multiple \
+             '--cover-letter'. A cover letter is recommended when sending multiple \
              patches. The `format.coverLetter` configuration value may be set true to \
              always generate a cover letter or 'auto' to generate a cover letter when \
              formatting more than one patch.\n\
              \n\
-             Recipients may be specified using the --to and --cc, or setting recipients \
-             may be deferred to `stg email send`.\n\
+             Recipients may be specified using the '--to' and '--cc', or setting \
+             recipients may be deferred to `stg email send`.\n\
              \n\
              Many aspects of the format behavior may be controlled via `format.*` \
              configuration values. Refer to the git-config(1) and git-format-patch(1) \
@@ -136,11 +136,11 @@ fn format_options() -> Vec<Arg> {
                 "Mark the series as the <n>-th iteration of the topic. The output \
                  filenames have \"v<n>\" prepended to them, and the subject prefix \
                  (\"PATCH\" by default, but configurable via the --subject-prefix \
-                 option) has ` v<N>` appended to it. E.g. --reroll-count=4 may produce \
-                 v4-0001-add-makefile.patch file that has \"Subject: [PATCH v4 1/20] \
-                 Add makefile\" in it. <N> does not have to be an integer (e.g. \
-                 \"--reroll-count=4.4\", or \"--reroll-count=4rev2\" are allowed), but \
-                 the downside of using such a reroll-count is that the \
+                 option) has ` v<N>` appended to it. E.g. '--reroll-count=4' may \
+                 produce v4-0001-add-makefile.patch file that has \"Subject: [PATCH v4
+                 1/20] Add makefile\" in it. <N> does not have to be an integer (e.g. \
+                 '--reroll-count=4.4', or '--reroll-count=4rev2' are allowed), but the \
+                 downside of using such a reroll-count is that the \
                  range-diff/interdiff with the previous version does not state exactly \
                  which version the new interation is compared against.",
             )
@@ -150,7 +150,7 @@ fn format_options() -> Vec<Arg> {
             .long("rfc")
             .help("Use [RFC PATCH] instead of [PATCH]")
             .long_help(
-                "Alias for --subject-prefix=\"RFC PATCH\". RFC means \"Request For \
+                "Alias for '--subject-prefix=\"RFC PATCH\"'. RFC means \"Request For \
                  Comments\"; use this when sending an experimental patch for \
                  discussion rather than application.",
             )
@@ -161,7 +161,7 @@ fn format_options() -> Vec<Arg> {
             .long_help(
                 "Instead of the standard `[PATCH]` prefix in the subject line, instead \
                  use `[<prefix>]`. This allows for useful naming of a patch series, \
-                 and can be combined with the `--numbered` option.",
+                 and can be combined with the '--numbered' option.",
             )
             .value_name("prefix")
             .num_args(1),
@@ -192,7 +192,7 @@ fn format_options() -> Vec<Arg> {
             .help("Use <suffix> instead of '.patch'")
             .long_help(
                 "Instead of using `.patch` as the suffix for generated filenames, use \
-                 specified suffix. A common alternative is `--suffix=.txt`. Leaving \
+                 specified suffix. A common alternative is '--suffix=.txt'. Leaving \
                  this empty will remove the `.patch` suffix.",
             )
             .value_name("suffix")
@@ -239,7 +239,7 @@ fn message_options() -> Vec<Arg> {
             .long_help(
                 "Add a `To:` header to the email headers. This is in addition to any \
                  configured headers, and may be used multiple times. The negated form \
-                 `--no-to` discards all `To:` headers added so far (from config or \
+                 '--no-to' discards all `To:` headers added so far (from config or \
                  command line).",
             )
             .value_name("address")
@@ -258,7 +258,7 @@ fn message_options() -> Vec<Arg> {
             .long_help(
                 "Add a `Cc:` header to the email headers. This is in addition to any \
                  configured headers, and may be used multiple times. The negated form \
-                 `--no-cc` discards all `Cc:` headers added so far (from config or \
+                 '--no-cc' discards all `Cc:` headers added so far (from config or \
                  command line).",
             )
             .value_name("address")
@@ -275,7 +275,7 @@ fn message_options() -> Vec<Arg> {
             .long("in-reply-to")
             .help("Make first mail a reply to <message-id>")
             .long_help(
-                "Make the first mail (or all the mails with `--no-thread`) appear as a \
+                "Make the first mail (or all the mails with '--no-thread') appear as a \
                  reply to the given <message-id>, which avoids breaking threads to \
                  provide a new patch series.",
             )
@@ -288,8 +288,8 @@ fn message_options() -> Vec<Arg> {
             .long_help(
                 "Add an arbitrary header to the email headers. This is in addition to \
                  any configured headers, and may be used multiple times. For example, \
-                 `--add-header=\"Organization: git-foo\"`.",
-                // "The negated form `--no-add-header` discards all (`To:`, `Cc:`, \
+                 '--add-header=\"Organization: git-foo\"'.",
+                // "The negated form '--no-add-header' discards all (`To:`, `Cc:`, \
                 //  and custom)  headers added so far from config or command line."
             )
             .value_name("header")
@@ -327,11 +327,11 @@ fn message_options() -> Vec<Arg> {
                  The optional <style> argument can be either `shallow` or `deep`. \
                  `shallow` threading makes every mail a reply to the head of the \
                  series, where the head is chosen from the cover letter, the \
-                 `--in-reply-to`, and the first patch mail, in this order. `deep` \
+                 '--in-reply-to', and the first patch mail, in this order. `deep` \
                  threading makes every mail a reply to the previous one.\n\
                  \n\
-                 The default is `--no-thread`, unless the `format.thread` \
-                 configuration is set. If `--thread` is specified without a style, it \
+                 The default is '--no-thread', unless the `format.thread` \
+                 configuration is set. If '--thread' is specified without a style, it \
                  defaults to the style specified by `format.thread` if any, or else \
                  `shallow`.\n\
                  \n\
@@ -355,7 +355,7 @@ fn message_options() -> Vec<Arg> {
             .long_help(
                 "Add a signature string to each email. The default signature is the \
                  git version number, or the `format.signature` configuration value, if \
-                 specified. The signature may be disabled with `--no-signature`",
+                 specified. The signature may be disabled with '--no-signature'",
             )
             .num_args(1)
             .value_name("signature")
@@ -367,7 +367,7 @@ fn message_options() -> Vec<Arg> {
         Arg::new("signature-file")
             .long("signature-file")
             .help("Add a signature from a file")
-            .long_help("Like `--signature` except the signature is read from a file.")
+            .long_help("Like '--signature' except the signature is read from a file.")
             .num_args(1)
             .value_name("file")
             .value_hint(clap::ValueHint::FilePath),
@@ -425,7 +425,7 @@ fn message_options() -> Vec<Arg> {
             .long("creation-factor")
             .help("Percentage by which creation is weighed")
             .long_help(
-                "Used with `--range-diff`, tweak the heuristic which matches up \
+                "Used with '--range-diff', tweak the heuristic which matches up \
                  commits between the previous and current series of patches by \
                  adjusting the creation/deletion cost fudge factor. See \
                  git-range-diff(1)) for details.",

src/cmd/email/send.rs

@@ -124,7 +124,7 @@ fn compose_options() -> Vec<Arg> {
                 "Specify the primary recipient of the emails generated. Generally, \
                  this will be the upstream maintainer of the project involved. Default \
                  is the value of the sendemail.to configuration value; if that is \
-                 unspecified, and --to-cmd is not specified, this will be prompted \
+                 unspecified, and '--to-cmd' is not specified, this will be prompted \
                  for.\n\
                  \n\
                  This option may be specified multiple times.",
@@ -167,8 +167,8 @@ fn compose_options() -> Vec<Arg> {
             .help("Specify email \"Subject:\"")
             .long_help(
                 "Specify the initial subject of the email thread. Only necessary if \
-                 --compose is also set. If --compose is not set, this will be prompted \
-                 for.",
+                 '--compose' is also set. If '--compose' is not set, this will be \
+                 prompted for.",
             )
             .value_name("subject")
             .num_args(1)
@@ -179,7 +179,7 @@ fn compose_options() -> Vec<Arg> {
             .long_help(
                 "Specify the address where replies from recipients should go to. Use \
                  this if replies to messages should go to another address than what is \
-                 specified with the --from parameter.",
+                 specified with the '--from' parameter.",
             )
             .value_name("address")
             .num_args(1)
@@ -189,15 +189,15 @@ fn compose_options() -> Vec<Arg> {
             .long("in-reply-to")
             .help("Specify the \"In-Reply-To:\" identifier")
             .long_help(
-                "Make the first mail (or all the mails with --no-thread) appear as a \
+                "Make the first mail (or all the mails with '--no-thread') appear as a \
                  reply to the given Message-Id, which avoids breaking threads to \
                  provide a new patch series. The second and subsequent emails will be \
-                 sent as replies according to the --[no-]chain-reply-to setting.\n\
+                 sent as replies according to the '--[no-]chain-reply-to' setting.\n\
                  \n\
-                 So for example when --thread and --no-chain-reply-to are specified, \
-                 the second and subsequent patches will be replies to the first one \
-                 like in the illustration below where [PATCH v2 0/3] is in reply to \
-                 [PATCH 0/2]:\n\
+                 So for example when '--thread' and '--no-chain-reply-to' are \
+                 specified, the second and subsequent patches will be replies to the \
+                 first one like in the illustration below where [PATCH v2 0/3] is in \
+                 reply to [PATCH 0/2]:\n\
                  \n    [PATCH 0/2] Here is what I did...\
                  \n      [PATCH 1/2] Clean up and tests\
                  \n      [PATCH 2/2] Implementation\
@@ -206,7 +206,7 @@ fn compose_options() -> Vec<Arg> {
                  \n        [PATCH v2 2/3] New tests\
                  \n        [PATCH v2 3/3] Implementation\
                  \n\n\
-                 Only necessary if --compose is also set. If --compose is not set, \
+                 Only necessary if '--compose' is also set. If '--compose' is not set, \
                  this will be prompted for.",
             )
             .value_name("id")
@@ -219,7 +219,7 @@ fn compose_options() -> Vec<Arg> {
                 "Invoke a text editor (see GIT_EDITOR in git-var(1)) to edit an \
                  introductory message for the patch series.\n\
                  \n\
-                 When --compose is used, git send-email will use the From, Subject, \
+                 When '--compose' is used, git send-email will use the From, Subject, \
                  and In-Reply-To headers specified in the message. If the body of the \
                  message (what you type after the headers and a blank line) only \
                  contains blank (or Git: prefixed) lines, the summary will not be \
@@ -265,12 +265,12 @@ fn automate_options() -> Vec<Arg> {
                  be added to each email sent. Whether each mail refers to the previous \
                  email (deep threading per `git format-patch` wording) or to the first \
                  email (shallow threading) is governed by \
-                 \"--[no-]chain-reply-to\".\n\
+                 '--[no-]chain-reply-to'.\n\
                  \n\
-                 If disabled with \"--no-thread\", those headers will not be added \
-                 (unless specified with --in-reply-to). Default is the value of the \
+                 If disabled with '--no-thread', those headers will not be added \
+                 (unless specified with '--in-reply-to'). Default is the value of the \
                  sendemail.thread configuration value; if that is unspecified, default \
-                 to --thread.\n\
+                 to '--thread'.\n\
                  \n\
                  It is up to the user to ensure that no In-Reply-To header already \
                  exists when `git send-email` is asked to add it (especially note that \

src/cmd/export.rs

@@ -36,7 +36,7 @@ fn make() -> clap::Command {
             "Export a range of patches to a given directory in unified diff format. \
              All applied patches are exported by default.\n\
              \n\
-             Patches are exported to 'patches-<branch>' by default. The --dir option \
+             Patches are exported to 'patches-<branch>' by default. The '--dir' option \
              may be used to specify a different output directory.\n\
              \n\
              The patch file output may be customized via a template file found at \

src/cmd/fold.rs

@@ -24,13 +24,13 @@ fn make() -> clap::Command {
     clap::Command::new(STGIT_COMMAND.name)
         .about("Fold diff file into the current patch")
         .long_about(
-            "Fold diff file into the current patch. The given GNU diff file (or standard input) \
-             is applied onto the current patch.\n\
+            "Fold diff file into the current patch. The given GNU diff file (or \
+             standard input) is applied onto the current patch.\n\
              \n\
-             With the --threeway option, the diff is applied onto the bottom of the current patch \
-             and a three-way merge is performed with the current top. With the --base option, the \
-             diff is applied onto the specified base and a three-way merge is performed with the \
-             current top.",
+             With the '--threeway' option, the diff is applied onto the bottom of the \
+             current patch and a three-way merge is performed with the current top. \
+             With the '--base' option, the diff is applied onto the specified base and \
+             a three-way merge is performed with the current top.",
         )
         .arg(
             Arg::new("file")

src/cmd/import.rs

@@ -35,8 +35,8 @@ fn make() -> clap::Command {
              \n\
              The simplest usage is to import a diff/patch file into the stack from a \
              local file. By default, the file name is used as the patch name, but this \
-             can be overridden with --name. The patch can either be a normal file with \
-             the description at the top, or it can have standard mail format. The \
+             can be overridden with '--name'. The patch can either be a normal file \
+             with the description at the top, or it can have standard mail format. The \
              \"Subject\", \"From\", and \"Date\" headers will be used for the imported \
              patch's author details.\n\
              \n\
@@ -70,8 +70,8 @@ fn make() -> clap::Command {
                 .help("Source of patches to import")
                 .long_help(
                     "Source of patches to import. May be a path to a local file or a \
-                     URL if the --url option is provided. The default is to read from \
-                     stdin if no source argument is provided.",
+                     URL if the '--url' option is provided. The default is to read \
+                     from stdin if no source argument is provided.",
                 )
                 .value_parser(clap::value_parser!(PathBuf))
                 .value_hint(clap::ValueHint::AnyPath),
@@ -185,8 +185,8 @@ fn make() -> clap::Command {
                 .long_help(
                     "Create Message-Id trailer in patch description based on the \
                     Message-ID email header. This option is applicable when importing \
-                    with --mail or --mbox. This behavior may also be enabled via the \
-                    \"stgit.import.message-id\" configuration option.",
+                    with '--mail' or '--mbox'. This behavior may also be enabled via \
+                    the \"stgit.import.message-id\" configuration option.",
                 )
                 .action(clap::ArgAction::SetTrue),
         );