Rename to --diff-opt and --git-opt

Since the former --diff-opts option now only supports one git option per
occurrence, the singular --diff-opt naming becomes more appropriate. The
former --diff-opts option name remains supported as a hidden alias to ease
compatibility with older versions of StGit.

For `stg email format` and `stg email send`, the --git-opts option is
renamed to --git-opt for the same reason. However, since these are new
commands for StGit 2.0, the plural naming is not provided as an alias.

This also corrects the zsh completion for --diff-opt to allow multiple
occurrences.

Ref: #220

Author: jpgrayson

completion/stgit.zsh

@@ -420,7 +420,7 @@ _stg-delete() {
 _stg-diff() {
     local -a subcmd_args
     __stg_add_args_help
-    __stg_add_args_diffopts
+    __stg_add_args_diffopt
     subcmd_args+=(
         '(-r --range)'{-r,--range=}'[show diff between revisions]: :__stg_patchrange --suggest-range --all'
         '(-s --stat)'{-s,--stat}'[show stat instead of diff]'
@@ -486,7 +486,7 @@ _stg-email-format() {
     __stg_add_args_color
     __stg_add_args_branch
     subcmd_args+=(
-        '*'{-G+,--git-opts=}'[extra options for git-format-patch]:opts:__stg_git_format_patch_opts'
+        '*'{-G+,--git-opt=}'[extra option for git-format-patch]:opt:__stg_git_format_patch_opts'
         '(-o --output-directory)'{-o+,--output-directory=}'[store resulting files in given directory]: :_directories'
         '(-n --numbered -N --no-numbered -k --keep-subject)'{-n,--numbered}'[name output in \[PATCH n/m\] format]'
         '(-n --numbered -N --no-numbered -k --keep-subject)'{-N,--no-numbered}'[name output in \[PATCH\] format]'
@@ -541,7 +541,7 @@ _stg-email-send() {
     __stg_add_args_help
     __stg_add_args_color
     subcmd_args+=(
-        '*'{-G+,--git-opts=}'[extra options for git-send-email]:opts:__stg_git_send_email_opts'
+        '*'{-G+,--git-opt=}'[extra option for git-send-email]:opt:__stg_git_send_email_opts'
         '--from=[specify sender]:email address:_email_addresses'
         '--to=[specify the primary recipient of the emails]: :_email_addresses'
         '--cc=[starting Cc: value for each email]: :_email_addresses'
@@ -605,7 +605,7 @@ _stg-export() {
     local -a subcmd_args
     __stg_add_args_help
     __stg_add_args_branch
-    __stg_add_args_diffopts
+    __stg_add_args_diffopt
     subcmd_args+=(
         '(-d --dir)'{-d,--dir}'[export patches to directory]: :_directories'
         '(-n --numbered)'{-n,--numbered}'[prefix patch names with order numbers]'
@@ -786,7 +786,7 @@ _stg-patches() {
     local -a subcmd_args
     __stg_add_args_help
     __stg_add_args_branch
-    __stg_add_args_diffopts
+    __stg_add_args_diffopt
     subcmd_args+=(
         '(-d --diff)'{-d,--diff}'[show diffs of given files]'
         '*:files:__stg_cached_files'
@@ -901,7 +901,7 @@ _stg-refresh() {
     __stg_add_args_edit
     __stg_add_args_hook
     __stg_add_args_trailers
-    __stg_add_args_diffopts
+    __stg_add_args_diffopt
     subcmd_args+=(
         '(-a --annotate)'{-a,--annotate=}'[annotate patch log entry]:note'
         '(-d --diff)'{-d,--diff}'[show diff when editing patch message]'
@@ -984,7 +984,7 @@ _stg-show() {
 
     __stg_add_args_help
     __stg_add_args_branch
-    __stg_add_args_diffopts
+    __stg_add_args_diffopt
     subcmd_args+=(
         '(*)'{-p,--patch=}'[patch or revision to show]: :__stg_dedup_inside_arguments __stg_patchrange --all'
         '(-s --stat)'{-s,--stat}'[show diff stat]'
@@ -1148,10 +1148,9 @@ __stg_add_args_color() {
     )
 }
 
-__stg_add_args_diffopts() {
-    # TODO: complete diff-opts values (with separators?)
+__stg_add_args_diffopt() {
     subcmd_args+=(
-        '(-O --diff-opts)'{-O+,--diff-opts=}'[extra options for git diff]:opts:__stg_git_diff_opts'
+        '*'{-O+,--diff-opt=}'[extra option for git diff]:opt:__stg_git_diff_opts'
     )
 }
 
@@ -1211,7 +1210,7 @@ __stg_git_diff_opts() {
     words=('git' ${(@)__stg_C_args} 'diff-tree')
     # Needs a way to know word indices for opt_args values to only provide through CURRENT.
     #
-    # words+=(${(0)opt_args[-O]} ${(0)opt_args[--diff-opts]})
+    # words+=(${(0)opt_args[-O]} ${(0)opt_args[--diff-opt]})
     words+=("$PREFIX$SUFFIX")
     (( CURRENT = $#words ))
 
@@ -1225,7 +1224,7 @@ __stg_git_format_patch_opts() {
     words=('git' ${(@)__stg_C_args} 'format-patch')
     # Needs a way to know word indices for opt_args values to only provide through CURRENT.
     #
-    # words+=(${(0)opt_args[-G]} ${(0)opt_args[--git-opts]})
+    # words+=(${(0)opt_args[-G]} ${(0)opt_args[--git-opt]})
     words+=("$PREFIX$SUFFIX")
     (( CURRENT = $#words ))
 
@@ -1239,7 +1238,7 @@ __stg_git_send_email_opts() {
     words=('git' ${(@)__stg_C_args} 'send-email')
     # Needs a way to know word indices for opt_args values to only provide through CURRENT.
     #
-    # words+=(${(0)opt_args[-G]} ${(0)opt_args[--git-opts]})
+    # words+=(${(0)opt_args[-G]} ${(0)opt_args[--git-opt]})
     words+=("$PREFIX$SUFFIX")
     (( CURRENT = $#words ))
 

examples/gitconfig

@@ -79,7 +79,7 @@
 	#namelength = 30
 
 	# Extra options to pass to "git diff" (extend/override with
-	# -O/--diff-opts). For example, -M turns on rename detection.
+	# -O/--diff-opt). For example, -M turns on rename detection.
 	#diff-opts = -M
 
 	# Behave as if the --keep option is always passed

src/argset.rs

@@ -34,20 +34,23 @@ pub(crate) fn merged_arg() -> Arg {
         .action(clap::ArgAction::SetTrue)
 }
 
-/// The `--diff-opts`/`-O` option for pass-through to subordinate `git` processes.
+/// The `--diff-opt`/`-O` option for pass-through to subordinate `git` processes.
 pub(crate) fn diff_opts_arg() -> Arg {
-    Arg::new("git-diff-opts")
-        .long("diff-opts")
+    Arg::new("git-diff-opt")
+        .long("diff-opt")
+        .alias("diff-opts")
         .short('O')
-        .help("Extra options to pass to \"git diff\"")
+        .help("Pass additional <option> to \"git diff\"")
         .long_help(
-            "Pass additional options <git-diff-options> to `git diff`. \
-             See the git-diff(1) man page.",
+            "Pass additional <option> to \"git diff\".\n\
+             \n\
+             See the git-diff(1) man page. This option may be specified multiple \
+             times.",
         )
         .num_args(1)
         .allow_hyphen_values(true)
         .action(clap::ArgAction::Append)
-        .value_name("git-diff-options")
+        .value_name("option")
         .value_hint(clap::ValueHint::Other)
 }
 
@@ -84,7 +87,7 @@ pub(crate) fn parse_usize(s: &str) -> anyhow::Result<usize> {
 /// diff options.
 ///
 /// The base set of options come from `stgit.diff-opts` in the config. Additional
-/// options from `--diff-opts`/`-O` command line options are appended. And StGit
+/// options from `--diff-opt`/`-O` command line options are appended. And StGit
 /// command-specific policies for displaying the full object id (`--full-index`) and
 /// including binary diffs (`--binary`) are tacked on at the end.
 ///
@@ -104,7 +107,7 @@ pub(crate) fn get_diff_opts(
         }
     }
 
-    if let Some(values) = matches.get_many::<String>("git-diff-opts") {
+    if let Some(values) = matches.get_many::<String>("git-diff-opt") {
         opts.extend(values.cloned());
     }
 

src/cmd/completion/bash.rs

@@ -219,12 +219,12 @@ fn insert_compreply(script: &mut ShStream, arg: &clap::Arg) {
             "committish" => script.line(
                 "mapfile -t COMPREPLY < <(compgen -W \"$(_all_branches) $(_tags) $(_remotes)\")",
             ),
-            "git-diff-opts" => script
+            "git-diff-opt" => script
                 .line("mapfile -t COMPREPLY < <(compgen -W \"$(_git_diff_opts)\" -- \"$cur\")"),
-            "git-format-patch-opts" => script.line(
+            "git-format-patch-opt" => script.line(
                 "mapfile -t COMPREPLY < <(compgen -W \"$(_git_format_patch_opts)\" -- \"$cur\")",
             ),
-            "git-send-email-opts" => script.line(
+            "git-send-email-opt" => script.line(
                 "mapfile -t COMPREPLY < <(compgen -W \"$(_git_send_email_opts)\" -- \"$cur\")",
             ),
             "patch" => script

src/cmd/completion/fish.rs

@@ -363,7 +363,7 @@ fn get_arg_completion_params(arg: &clap::Arg) -> ShStream {
             "branch" | "ref-branch" => params.word("-xa '(__fish_stg_stg_branches)'"),
             "branch-any" => params.word("-xa '(__fish_stg_all_branches)'"),
             "committish" => params.word("-xa '(__fish_stg_commit)'"),
-            "git-diff-opts" => params.word("-xa '(__fish_stg_git_diff_opts)'"),
+            "git-diff-opt" => params.word("-xa '(__fish_stg_git_diff_opts)'"),
             "git-format-patch-opts" => params.word("-xa '(__fish_stg_git_format_patch_opts)'"),
             "git-send-email-opts" => params.word("-xa '(__fish_stg_git_send_email_opts)'"),
             "patch" | "patchranges" => params.word("-kxa '(__fish_stg_patches -A -U)'"),

src/cmd/email/format.rs

@@ -68,17 +68,19 @@ pub(super) fn command() -> clap::Command {
                 .action(clap::ArgAction::SetTrue),
         )
         .arg(
-            Arg::new("git-format-patch-opts")
-                .long("git-opts")
+            Arg::new("git-format-patch-opt")
+                .long("git-opt")
                 .short('G')
-                .help("Extra options to pass to \"git format-patch\"")
+                .help("Pass additional <option> to \"git format-patch\"")
                 .long_help(
-                    "Pass additional options <git-options> to `git format-patch`. \
-                     See the git-format-patch(1) man page.",
+                    "Pass additional <option> to \"git format-patch\".\n\
+                     \n\
+                     See the git-format-patch(1) man page. This option may be \
+                     specified multiple times.",
                 )
                 .allow_hyphen_values(true)
                 .action(clap::ArgAction::Append)
-                .value_name("git-options"),
+                .value_name("option"),
         )
         .next_help_heading("Format Options")
         .args(format_options())
@@ -505,7 +507,7 @@ pub(super) fn dispatch(matches: &clap::ArgMatches) -> Result<()> {
 
     let mut format_args = format_args.drain(..).map(|(_, s)| s).collect::<Vec<_>>();
 
-    if let Some(values) = matches.get_many::<String>("git-format-patch-opts") {
+    if let Some(values) = matches.get_many::<String>("git-format-patch-opt") {
         format_args.extend(values.cloned());
     }
 

src/cmd/email/send.rs

@@ -75,17 +75,19 @@ pub(super) fn command() -> clap::Command {
                 .conflicts_with_all(["patchranges-or-paths", "dump-aliases"]),
         )
         .arg(
-            Arg::new("git-send-email-opts")
-                .long("git-opts")
+            Arg::new("git-send-email-opt")
+                .long("git-opt")
                 .short('G')
-                .help("Extra options to pass to \"git send-email\"")
+                .help("Pass additional <option> to \"git send-email\"")
                 .long_help(
-                    "Pass additional options <git-options> to `git send-email`. \
-                     See the git-send-email(1) man page.",
+                    "Pass additional <option> to \"git send-email\".\n\
+                     \n\
+                     See the git-send-email(1) man page. This option may be specified \
+                     multiple times.",
                 )
                 .allow_hyphen_values(true)
                 .action(clap::ArgAction::Append)
-                .value_name("git-options"),
+                .value_name("option"),
         )
         .next_help_heading("Compose Options")
         .args(compose_options())
@@ -458,7 +460,7 @@ pub(super) fn dispatch(matches: &clap::ArgMatches) -> Result<()> {
 
     let mut send_args = send_args.drain(..).map(|(_, s)| s).collect::<Vec<_>>();
 
-    if let Some(values) = matches.get_many::<String>("git-send-email-opts") {
+    if let Some(values) = matches.get_many::<String>("git-send-email-opt") {
         send_args.extend(values.cloned());
     }
 

t/t0005-show.sh

@@ -38,13 +38,13 @@ test_expect_success 'Show patch' '
 '
 
 test_expect_success 'Bad diff opts' '
-    command_error stg show --diff-opts=--this-is-bad 2>err &&
+    command_error stg show --diff-opt=--this-is-bad 2>err &&
     grep -e "unrecognized argument: --this-is-bad" err
 '
 
 test_expect_success 'Multiple diff opts' '
-    stg show --diff-opts=--shortstat --diff-opts="--name-only" patch-bbb |
-    grep -e "foo.txt"
+    stg show --diff-opt=--line-prefix="A B C " --diff-opt="--name-only" patch-bbb >out &&
+    grep -e "A B C foo.txt" out
 '
 
 test_expect_success 'Diff opts from config' '

t/t0006-patches.sh

@@ -78,8 +78,8 @@ test_expect_success 'With diff output' '
     test $(cat even-diff.log | grep -c -E "p(0|1|3) message") = "3"
 '
 
-test_expect_success 'With diff output and diff-opts' '
-    stg patches --diff-opts=--abbrev -O --name-only --diff even.txt > even-diff2.log
+test_expect_success 'With diff output and diff-opt' '
+    stg patches --diff-opt=--abbrev -O --name-only --diff even.txt > even-diff2.log
     test $(cat even-diff2.log | grep -c -E "even.txt") = "3"
     test $(cat even-diff2.log | grep -c -E "p(0|1|3) message") = "3"
 '

t/t2400-diff.sh

@@ -33,8 +33,8 @@ test_expect_success 'Diff stat with some local changes' '
     test_cmp add-foo-stat.diff expected-add-foo-stat.diff
 '
 
-test_expect_success 'Diff with bad diff-opts' '
-    command_error stg diff --diff-opts=--bad-diff-opt
+test_expect_success 'Diff with bad diff-opt' '
+    command_error stg diff --diff-opt=--bad-diff-opt
 '
 
 test_expect_success 'Initialize StGit stuff' '
@@ -47,8 +47,9 @@ test_expect_success 'Diff with some local changes' '
     test_cmp add-foo.diff add-foo2.diff
 '
 
-test_expect_success 'Diff with multiple diff-opts' '
-    stg diff --diff-opts=--shortstat -O --name-only | grep -e "foo.txt"
+test_expect_success 'Diff with multiple diff-opt' '
+    stg diff --diff-opt=--line-prefix="A B C " -O --name-only >out &&
+    grep -e "A B C foo.txt" out
 '
 
 test_expect_success 'Refresh patch' '
@@ -179,7 +180,7 @@ test_expect_success 'Binary diff range' '
 '
 
 test_expect_success 'Binary diff range with --binary' '
-    stg diff -r p5..p6 --diff-opts=--binary > num-binary2.diff &&
+    stg diff -r p5..p6 --diff-opt=--binary > num-binary2.diff &&
     test_cmp num-binary.diff num-binary2.diff
 '