All of lore.kernel.org
 help / color / mirror / Atom feed
From: Johannes Sixt <j6t@kdbg.org>
To: Git Mailing List <git@vger.kernel.org>
Subject: [PATCH] replace "parameters" by "arguments" in error messages
Date: Tue, 23 Feb 2021 08:38:52 +0100	[thread overview]
Message-ID: <40b2fedc-fdde-1fc0-ef98-86d8ea638193@kdbg.org> (raw)

When an error message informs the user about an incorrect command
invocation, it should refer to "arguments", not "parameters".

Signed-off-by: Johannes Sixt <j6t@kdbg.org>
---
  Recently, I was greated by an accidental `git tag` invocation:

  $ git tag one two three
  fatal: too many params

  This is bad in two regards: (1) There's a techie-speak abbreviation
  in a user-visible text, (2) and it is wrong terminology to refer to
  "parameters" when "arguments" would be correct.

  Then I looked at every single occurrence of "parameter" in Documentation/
  and half-way through the rest and wanted to  correct all incorrect uses,
  but things are by far not as clear-cut as I hoped.

  So, I stopped here and fixed the one pain point that triggered the voyage,
  which I hope is not too controversal.

  bisect.c                    |  2 +-
  builtin/notes.c             | 20 ++++++++++----------
  builtin/stash.c             |  2 +-
  builtin/tag.c               |  2 +-
  t/t3301-notes.sh            |  6 +++---
  t/t6030-bisect-porcelain.sh |  4 ++--
  6 files changed, 18 insertions(+), 18 deletions(-)

diff --git a/bisect.c b/bisect.c
index 75ea0eb57f..ae48d19acf 100644
--- a/bisect.c
+++ b/bisect.c
@@ -1064,7 +1064,7 @@ enum bisect_error bisect_next_all(struct repository *r, const char *prefix)
  
  	if (!all) {
  		fprintf(stderr, _("No testable commit found.\n"
-			"Maybe you started with bad path parameters?\n"));
+			"Maybe you started with bad path arguments?\n"));
  
  		return BISECT_NO_TESTABLE_COMMIT;
  	}
diff --git a/builtin/notes.c b/builtin/notes.c
index 2987c08a2e..08b8914d29 100644
--- a/builtin/notes.c
+++ b/builtin/notes.c
@@ -373,7 +373,7 @@ static int list(int argc, const char **argv, const char *prefix)
  				     git_notes_list_usage, 0);
  
  	if (1 < argc) {
-		error(_("too many parameters"));
+		error(_("too many arguments"));
  		usage_with_options(git_notes_list_usage, options);
  	}
  
@@ -428,7 +428,7 @@ static int add(int argc, const char **argv, const char *prefix)
  			     PARSE_OPT_KEEP_ARGV0);
  
  	if (2 < argc) {
-		error(_("too many parameters"));
+		error(_("too many arguments"));
  		usage_with_options(git_notes_add_usage, options);
  	}
  
@@ -506,7 +506,7 @@ static int copy(int argc, const char **argv, const char *prefix)
  
  	if (from_stdin || rewrite_cmd) {
  		if (argc) {
-			error(_("too many parameters"));
+			error(_("too many arguments"));
  			usage_with_options(git_notes_copy_usage, options);
  		} else {
  			return notes_copy_from_stdin(force, rewrite_cmd);
@@ -514,11 +514,11 @@ static int copy(int argc, const char **argv, const char *prefix)
  	}
  
  	if (argc < 1) {
-		error(_("too few parameters"));
+		error(_("too few arguments"));
  		usage_with_options(git_notes_copy_usage, options);
  	}
  	if (2 < argc) {
-		error(_("too many parameters"));
+		error(_("too many arguments"));
  		usage_with_options(git_notes_copy_usage, options);
  	}
  
@@ -595,7 +595,7 @@ static int append_edit(int argc, const char **argv, const char *prefix)
  			     PARSE_OPT_KEEP_ARGV0);
  
  	if (2 < argc) {
-		error(_("too many parameters"));
+		error(_("too many arguments"));
  		usage_with_options(usage, options);
  	}
  
@@ -662,7 +662,7 @@ static int show(int argc, const char **argv, const char *prefix)
  			     0);
  
  	if (1 < argc) {
-		error(_("too many parameters"));
+		error(_("too many arguments"));
  		usage_with_options(git_notes_show_usage, options);
  	}
  
@@ -812,7 +812,7 @@ static int merge(int argc, const char **argv, const char *prefix)
  		error(_("must specify a notes ref to merge"));
  		usage_with_options(git_notes_merge_usage, options);
  	} else if (!do_merge && argc) {
-		error(_("too many parameters"));
+		error(_("too many arguments"));
  		usage_with_options(git_notes_merge_usage, options);
  	}
  
@@ -960,7 +960,7 @@ static int prune(int argc, const char **argv, const char *prefix)
  			     0);
  
  	if (argc) {
-		error(_("too many parameters"));
+		error(_("too many arguments"));
  		usage_with_options(git_notes_prune_usage, options);
  	}
  
@@ -982,7 +982,7 @@ static int get_ref(int argc, const char **argv, const char *prefix)
  			     git_notes_get_ref_usage, 0);
  
  	if (argc) {
-		error(_("too many parameters"));
+		error(_("too many arguments"));
  		usage_with_options(git_notes_get_ref_usage, options);
  	}
  
diff --git a/builtin/stash.c b/builtin/stash.c
index 9bc85f91cd..60813d70d3 100644
--- a/builtin/stash.c
+++ b/builtin/stash.c
@@ -222,7 +222,7 @@ static int clear_stash(int argc, const char **argv, const char *prefix)
  			     PARSE_OPT_STOP_AT_NON_OPTION);
  
  	if (argc)
-		return error(_("git stash clear with parameters is "
+		return error(_("git stash clear with arguments is "
  			       "unimplemented"));
  
  	return do_clear_stash();
diff --git a/builtin/tag.c b/builtin/tag.c
index e8b85eefd8..482d1b7d28 100644
--- a/builtin/tag.c
+++ b/builtin/tag.c
@@ -564,7 +564,7 @@ int cmd_tag(int argc, const char **argv, const char *prefix)
  
  	object_ref = argc == 2 ? argv[1] : "HEAD";
  	if (argc > 2)
-		die(_("too many params"));
+		die(_("too many arguments"));
  
  	if (get_oid(object_ref, &object))
  		die(_("Failed to resolve '%s' as a valid ref."), object_ref);
diff --git a/t/t3301-notes.sh b/t/t3301-notes.sh
index 4af881f0ba..d742be8840 100755
--- a/t/t3301-notes.sh
+++ b/t/t3301-notes.sh
@@ -1293,11 +1293,11 @@ test_expect_success 'GIT_NOTES_REWRITE_REF overrides config' '
  	grep "replacement note 3" actual
  '
  
-test_expect_success 'git notes copy diagnoses too many or too few parameters' '
+test_expect_success 'git notes copy diagnoses too many or too few arguments' '
  	test_must_fail git notes copy 2>error &&
-	test_i18ngrep "too few parameters" error &&
+	test_i18ngrep "too few arguments" error &&
  	test_must_fail git notes copy one two three 2>error &&
-	test_i18ngrep "too many parameters" error
+	test_i18ngrep "too many arguments" error
  '
  
  test_expect_success 'git notes get-ref expands refs/heads/main to refs/notes/refs/heads/main' '
diff --git a/t/t6030-bisect-porcelain.sh b/t/t6030-bisect-porcelain.sh
index 7bcde054d7..43608abcb7 100755
--- a/t/t6030-bisect-porcelain.sh
+++ b/t/t6030-bisect-porcelain.sh
@@ -578,9 +578,9 @@ test_expect_success 'skipping away from skipped commit' '
  	test "$para3" = "$PARA_HASH3"
  '
  
-test_expect_success 'erroring out when using bad path parameters' '
+test_expect_success 'erroring out when using bad path arguments' '
  	test_must_fail git bisect start $PARA_HASH7 $HASH1 -- foobar 2> error.txt &&
-	test_i18ngrep "bad path parameters" error.txt
+	test_i18ngrep "bad path arguments" error.txt
  '
  
  test_expect_success 'test bisection on bare repo - --no-checkout specified' '
-- 
2.30.0.455.ge51aa30bde


             reply	other threads:[~2021-02-23  7:40 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-02-23  7:38 Johannes Sixt [this message]
2021-02-23  8:28 ` [PATCH] replace "parameters" by "arguments" in error messages Junio C Hamano
2021-02-23 21:11   ` Johannes Sixt

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=40b2fedc-fdde-1fc0-ef98-86d8ea638193@kdbg.org \
    --to=j6t@kdbg.org \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.