Use lowercase arg value names

jpgrayson · jpgrayson · commit 45d2e812b36a · 2022-07-28T13:54:26.000-04:00
Lowercase value names is the dominant convention in git's man pages, so
StGit attaches to that convention too.

Also use bracketed form in help strings, e.g. "Help for &lt;value&gt;".
diff --git a/src/argset.rs b/src/argset.rs
@@ -11,7 +11,7 @@ lazy_static! {
         .short('b')
         .help("Use BRANCH instead of current branch")
         .takes_value(true)
-        .value_name("BRANCH")
+        .value_name("branch")
         .value_hint(ValueHint::Other);
 
     /// The `--keep/-k` option.
@@ -32,7 +32,7 @@ lazy_static! {
         .takes_value(true)
         .allow_hyphen_values(true)
         .multiple_occurrences(true)
-        .value_name("OPTIONS")
+        .value_name("options")
         .value_hint(ValueHint::Other);
 }
 
diff --git a/src/cmd/completion/bash.rs b/src/cmd/completion/bash.rs
@@ -15,8 +15,8 @@ pub(super) fn command() -> clap::Command<'static> {
             clap::Arg::new("output")
                 .long("output")
                 .short('o')
-                .help("Output completion script to PATH")
-                .value_name("PATH")
+                .help("Output completion script to <path>")
+                .value_name("path")
                 .value_hint(clap::ValueHint::FilePath)
                 .allow_invalid_utf8(true),
         )
diff --git a/src/cmd/completion/fish.rs b/src/cmd/completion/fish.rs
@@ -15,8 +15,8 @@ pub(super) fn command() -> clap::Command<'static> {
             clap::Arg::new("output")
                 .long("output")
                 .short('o')
-                .help("Output completion script to PATH")
-                .value_name("PATH")
+                .help("Output completion script to <path>")
+                .value_name("path")
                 .value_hint(clap::ValueHint::FilePath)
                 .allow_invalid_utf8(true),
         )
diff --git a/src/cmd/completion/man.rs b/src/cmd/completion/man.rs
@@ -24,8 +24,8 @@ pub(super) fn command() -> clap::Command<'static> {
             clap::Arg::new("output")
                 .long("output")
                 .short('o')
-                .help("Output man pages to DIR")
-                .value_name("DIR")
+                .help("Output man pages to <dir>")
+                .value_name("dir")
                 .value_hint(clap::ValueHint::DirPath)
                 .allow_invalid_utf8(true),
         )
diff --git a/src/cmd/completion/mod.rs b/src/cmd/completion/mod.rs
@@ -40,9 +40,9 @@ fn make() -> clap::Command<'static> {
             clap::Arg::new("output")
                 .long("output")
                 .short('o')
-                .help("Output to PATH")
+                .help("Output to <path>")
                 .global(true)
-                .value_name("PATH")
+                .value_name("path")
                 .value_hint(clap::ValueHint::FilePath)
                 .allow_invalid_utf8(true),
         )
diff --git a/src/cmd/completion/zsh.rs b/src/cmd/completion/zsh.rs
@@ -11,8 +11,8 @@ pub(super) fn command() -> clap::Command<'static> {
             clap::Arg::new("output")
                 .long("output")
                 .short('o')
-                .help("Output completion script to PATH")
-                .value_name("PATH")
+                .help("Output completion script to <path>")
+                .value_name("path")
                 .value_hint(clap::ValueHint::FilePath)
                 .allow_invalid_utf8(true),
         )
diff --git a/src/cmd/email/format.rs b/src/cmd/email/format.rs
@@ -67,7 +67,7 @@ pub(super) fn command() -> clap::Command<'static> {
                 .help("Extra arguments passed to 'git format-patch'")
                 .last(true)
                 .allow_hyphen_values(true)
-                .value_name("GIT-OPTIONS"),
+                .value_name("git-options"),
         )
         .arg(&*crate::argset::BRANCH_ARG)
         .arg(
@@ -116,16 +116,16 @@ lazy_static! {
             .conflicts_with("numbered"),
         Arg::new("start-number")
             .long("start-number")
-            .help("Start numbering at N instead of 1")
-            .value_name("N")
+            .help("Start numbering at <n> instead of 1")
+            .value_name("n")
             .takes_value(true),
         Arg::new("reroll-count")
             .long("reroll-count")
             .short('v')
-            .help("Mark the series as the Nth reroll")
+            .help("Mark the series as the <n>th reroll")
             .long_help(
-                "Mark the series as the <N>-th iteration of the topic. The output \
-                 filenames have \"v<N>\" prepended to them, and the subject prefix \
+                "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] \
@@ -135,7 +135,7 @@ lazy_static! {
                  range-diff/interdiff with the previous version does not state exactly \
                  which version the new interation is compared against.",
             )
-            .value_name("N")
+            .value_name("n")
             .takes_value(true),
         Arg::new("rfc")
             .long("rfc")
@@ -414,7 +414,7 @@ lazy_static! {
                  git-range-diff(1)) for details.",
             )
             .takes_value(true)
-            .value_name("N")
+            .value_name("n")
             .forbid_empty_values(true),
         // NO --from
         // NO --no-add-header
diff --git a/src/cmd/email/send.rs b/src/cmd/email/send.rs
@@ -72,7 +72,7 @@ pub(super) fn command() -> clap::Command<'static> {
                 .help("Extra arguments passed to 'git send-email'")
                 .last(true)
                 .allow_hyphen_values(true)
-                .value_name("GIT-OPTIONS"),
+                .value_name("git-options"),
         )
         .arg(&*crate::argset::BRANCH_ARG)
         .arg(
@@ -310,14 +310,14 @@ lazy_static! {
             .conflicts_with("numbered"),
         Arg::new("start-number")
             .long("start-number")
-            .help("Start numbering at N instead of 1")
-            .value_name("N")
+            .help("Start numbering at <n> instead of 1")
+            .value_name("n")
             .takes_value(true),
         Arg::new("reroll-count")
             .long("reroll-count")
             .short('v')
-            .help("Mark the series as the Nth reroll")
-            .value_name("N")
+            .help("Mark the series as the <n>th reroll")
+            .value_name("n")
             .takes_value(true),
         Arg::new("rfc")
             .long("rfc")
diff --git a/src/cmd/export.rs b/src/cmd/export.rs
@@ -71,8 +71,8 @@ fn make() -> clap::Command<'static> {
             Arg::new("dir")
                 .long("dir")
                 .short('d')
-                .help("Export patches to DIR instead of the default")
-                .value_name("DIR")
+                .help("Export patches to <dir> instead of the default")
+                .value_name("dir")
                 .value_hint(clap::ValueHint::DirPath)
                 .allow_invalid_utf8(true),
         )
@@ -86,10 +86,10 @@ fn make() -> clap::Command<'static> {
             Arg::new("extension")
                 .long("extension")
                 .short('e')
-                .help("Suffix patch file names with \".<EXTENSION>\"")
+                .help("Suffix patch file names with \".<ext>\"")
                 .conflicts_with("patch")
                 .takes_value(true)
-                .value_name("EXTENSION"),
+                .value_name("ext"),
         )
         .arg(
             Arg::new("numbered")
@@ -101,8 +101,8 @@ fn make() -> clap::Command<'static> {
             Arg::new("template")
                 .long("template")
                 .short('t')
-                .help("Use FILE as template")
-                .value_name("FILE")
+                .help("Use <file> as template")
+                .value_name("file")
                 .value_hint(clap::ValueHint::FilePath)
                 .allow_invalid_utf8(true),
         )
diff --git a/src/cmd/float.rs b/src/cmd/float.rs
@@ -58,8 +58,8 @@ fn make() -> clap::Command<'static> {
             Arg::new("series")
                 .long("series")
                 .short('s')
-                .help("Rearrange according to a series FILE")
-                .value_name("FILE")
+                .help("Rearrange according to a series <file>")
+                .value_name("file")
                 .value_hint(clap::ValueHint::FilePath)
                 .allow_invalid_utf8(true)
                 .forbid_empty_values(true),
diff --git a/src/cmd/fold.rs b/src/cmd/fold.rs
@@ -52,16 +52,16 @@ fn make() -> clap::Command<'static> {
             Arg::new("base")
                 .long("base")
                 .short('b')
-                .help("Use BASE instead of HEAD when applying the patch")
-                .value_name("BASE"),
+                .help("Use <committish> instead of HEAD when applying the patch")
+                .value_name("committish"),
         )
         .group(ArgGroup::new("merge-style").args(&["three-way", "base"]))
         .arg(
             Arg::new("strip")
                 .long("strip")
                 .short('p')
-                .help("Remove N leading components from diff paths (default 1)")
-                .value_name("N")
+                .help("Remove <n> leading components from diff paths (default 1)")
+                .value_name("n")
                 .validator(|s| {
                     s.parse::<usize>()
                         .map_err(|_| format!("'{s}' is not an unsigned integer"))
@@ -70,8 +70,8 @@ fn make() -> clap::Command<'static> {
         .arg(
             Arg::new("context-lines")
                 .short('C')
-                .help("Ensure N lines of matching context for each change")
-                .value_name("N")
+                .help("Ensure <n> lines of matching context for each change")
+                .value_name("n")
                 .validator(|s| {
                     s.parse::<usize>()
                         .map_err(|_| format!("'{s}' is not an unsigned integer"))
diff --git a/src/cmd/import.rs b/src/cmd/import.rs
@@ -122,15 +122,15 @@ fn make() -> clap::Command<'static> {
             Arg::new("name")
                 .long("name")
                 .short('n')
-                .help("Use NAME as the patch name")
-                .value_name("NAME"),
+                .help("Use <name> as the patch name")
+                .value_name("name"),
         )
         .arg(
             Arg::new("strip")
                 .long("strip")
                 .short('p')
-                .help("Remove N leading components from diff paths (default 1)")
-                .value_name("N")
+                .help("Remove <n> leading components from diff paths (default 1)")
+                .value_name("n")
                 .validator(|s| {
                     s.parse::<usize>()
                         .map_err(|_| format!("'{s}' is not an unsigned integer"))
@@ -145,8 +145,8 @@ fn make() -> clap::Command<'static> {
         .arg(
             Arg::new("context-lines")
                 .short('C')
-                .help("Ensure N lines of matching context for each change")
-                .value_name("N")
+                .help("Ensure <n> lines of matching context for each change")
+                .value_name("n")
                 .validator(|s| {
                     s.parse::<usize>()
                         .map_err(|_| format!("'{s}' is not an unsigned integer"))
@@ -167,8 +167,8 @@ fn make() -> clap::Command<'static> {
             Arg::new("base")
                 .long("base")
                 .short('b')
-                .help("Use BASE instead of HEAD for file importing")
-                .value_name("COMMITTISH"),
+                .help("Use <committish> instead of HEAD for file importing")
+                .value_name("committish"),
         )
         .arg(
             Arg::new("reject")
diff --git a/src/cmd/log.rs b/src/cmd/log.rs
@@ -55,8 +55,8 @@ fn make() -> clap::Command<'static> {
             Arg::new("number")
                 .long("number")
                 .short('n')
-                .help("Limit output to N commits")
-                .value_name("N")
+                .help("Limit output to <n> commits")
+                .value_name("n")
                 .validator(|s| {
                     s.parse::<usize>()
                         .map_err(|_| format!("'{}' is not a positive integer", s))
diff --git a/src/cmd/pick.rs b/src/cmd/pick.rs
@@ -67,8 +67,8 @@ fn make() -> clap::Command<'static> {
             Arg::new("ref-branch")
                 .long("ref-branch")
                 .short('B')
-                .help("Pick patches from BRANCH")
-                .value_name("BRANCH"),
+                .help("Pick patches from <branch>")
+                .value_name("branch"),
         )
         .arg(
             Arg::new("revert")
@@ -94,8 +94,8 @@ fn make() -> clap::Command<'static> {
             Arg::new("name")
                 .long("name")
                 .short('n')
-                .help("Use NAME for the patch name")
-                .value_name("NAME")
+                .help("Use <name> for the patch name")
+                .value_name("name")
                 .validator(PatchName::from_str)
                 .forbid_empty_values(true)
                 .conflicts_with_all(&["fold", "update"]),
@@ -104,8 +104,8 @@ fn make() -> clap::Command<'static> {
             Arg::new("parent")
                 .long("parent")
                 .short('p')
-                .help("Use COMMITTISH as parent")
-                .value_name("COMMITTISH")
+                .help("Use <committish> as parent")
+                .value_name("committish")
                 .forbid_empty_values(true)
                 .conflicts_with_all(&["fold", "update"]),
         )
@@ -127,7 +127,7 @@ fn make() -> clap::Command<'static> {
                 .help("Only fold the given file (may be used multiple times)")
                 .forbid_empty_values(true)
                 .multiple_occurrences(true)
-                .value_name("PATH")
+                .value_name("path")
                 .requires("fold"),
         )
 }
diff --git a/src/cmd/pop.rs b/src/cmd/pop.rs
@@ -66,16 +66,16 @@ fn make() -> clap::Command<'static> {
             Arg::new("number")
                 .long("number")
                 .short('n')
-                .help("Pop specified number of patches")
+                .help("Pop specified <number> of patches")
                 .long_help(
-                    "Pop the specified number of patches.\n\
+                    "Pop the specified <number> of patches.\n\
                      \n\
                      A negative number indicates to pop all but that number \
                      of patches",
                 )
                 .takes_value(true)
                 .allow_hyphen_values(true) // i.e. for negative ints
-                .value_name("NUMBER")
+                .value_name("number")
                 .validator(|s| {
                     s.parse::<isize>()
                         .map_err(|_| format!("'{s}' is not an integer"))
diff --git a/src/cmd/push.rs b/src/cmd/push.rs
@@ -74,7 +74,7 @@ fn make() -> clap::Command<'static> {
                 )
                 .takes_value(true)
                 .allow_hyphen_values(true) // i.e. for negative ints
-                .value_name("NUMBER")
+                .value_name("n")
                 .validator(|s| {
                     s.parse::<isize>()
                         .map_err(|_| format!("'{s}' is not an integer"))
diff --git a/src/cmd/redo.rs b/src/cmd/redo.rs
@@ -36,8 +36,8 @@ fn make() -> clap::Command<'static> {
             Arg::new("number")
                 .long("number")
                 .short('n')
-                .help("Undo the last N undos")
-                .value_name("N")
+                .help("Undo the last <n> undos")
+                .value_name("n")
                 .validator(|s| {
                     s.parse::<isize>()
                         .map_err(|_| format!("'{s}' is not an integer"))
diff --git a/src/cmd/refresh.rs b/src/cmd/refresh.rs
@@ -108,19 +108,19 @@ fn make() -> clap::Command<'static> {
             Arg::new("patch")
                 .long("patch")
                 .short('p')
-                .help("Refresh (applied) PATCH instead of the top patch")
+                .help("Refresh (applied) <patch> instead of the top patch")
                 .takes_value(true)
-                .value_name("PATCH")
+                .value_name("patch")
                 .value_hint(ValueHint::Other)
                 .validator(PatchName::from_str),
         )
         .arg(
             Arg::new("annotate")
                 .long("annotate")
                 .short('a')
-                .help("Annotate the patch log entry with NOTE")
+                .help("Annotate the patch log entry with <note>")
                 .takes_value(true)
-                .value_name("NOTE")
+                .value_name("note")
                 .value_hint(ValueHint::Other),
         )
         .arg(
diff --git a/src/cmd/series.rs b/src/cmd/series.rs
@@ -96,9 +96,9 @@ fn make() -> clap::Command<'static> {
             Arg::new("missing")
                 .long("missing")
                 .short('m')
-                .help("Select patches in BRANCH not present in current branch")
+                .help("Select patches in <branch> not present in current branch")
                 .takes_value(true)
-                .value_name("BRANCH")
+                .value_name("branch")
                 .value_hint(ValueHint::Other),
         )
         .next_help_heading("DISPLAY OPTIONS")
diff --git a/src/cmd/sink.rs b/src/cmd/sink.rs
diff --git a/src/cmd/squash.rs b/src/cmd/squash.rs
diff --git a/src/cmd/sync.rs b/src/cmd/sync.rs
diff --git a/src/cmd/undo.rs b/src/cmd/undo.rs
diff --git a/src/patchedit/mod.rs b/src/patchedit/mod.rs
diff --git a/t/t0009-log.sh b/t/t0009-log.sh
diff --git a/t/t1201-push-noapply.sh b/t/t1201-push-noapply.sh
diff --git a/t/t1500-float.sh b/t/t1500-float.sh
diff --git a/t/t2600-squash.sh b/t/t2600-squash.sh
