git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH-2] Change writing style

From
Junio C Hamano <gitster@pobox.com>
Date
Nov 17, 2018, 09:04 UTC
Message-ID
<xmqqtvkggjna.fsf@gitster-ct.c.googlers.com>
In-Reply-To
<010201671ebf523a-da55f2d8-876a-4b3b-a6fe-29d790bed2c1-000000@eu-west-1.amazonses.com>
Jacques Bodin-Hullin <j.bodinhullin@monsieurbiz.com> writes:
> Subject: Re: [PATCH-2] Change writing style
Let's do the usual "<area>: summary" instead.  Perhaps
    Subject: parse-options: lose an unnecessary space in an error message

It is obvious why it is done, so I do not see a need for any other description in the body of the message for this change.

We still need the patch signed-off.  cf. Documentation/SubmittingPatches
> ---
>  parse-options.c          | 4 ++--
>  t/t0040-parse-options.sh | 4 ++--
>  2 files changed, 4 insertions(+), 4 deletions(-)
All changes look good to me.
Show 47 quoted lines
> diff --git a/parse-options.c b/parse-options.c
> index 3b874a83a0c89..f5ef24155950b 100644
> --- a/parse-options.c
> +++ b/parse-options.c
> @@ -352,7 +352,7 @@ static void check_typos(const char *arg, const struct option *options)
>  		return;
>  
>  	if (starts_with(arg, "no-")) {
> -		error ("did you mean `--%s` (with two dashes ?)", arg);
> +		error("did you mean `--%s` (with two dashes)?", arg);
>  		exit(129);
>  	}
>  
> @@ -360,7 +360,7 @@ static void check_typos(const char *arg, const struct option *options)
>  		if (!options->long_name)
>  			continue;
>  		if (starts_with(options->long_name, arg)) {
> -			error ("did you mean `--%s` (with two dashes ?)", arg);
> +			error("did you mean `--%s` (with two dashes)?", arg);
>  			exit(129);
>  		}
>  	}
> diff --git a/t/t0040-parse-options.sh b/t/t0040-parse-options.sh
> index 5b0560fa20e34..c442f9ae15ff8 100755
> --- a/t/t0040-parse-options.sh
> +++ b/t/t0040-parse-options.sh
> @@ -222,7 +222,7 @@ test_expect_success 'non ambiguous option (after two options it abbreviates)' '
>  '
>  
>  cat >typo.err <<\EOF
> -error: did you mean `--boolean` (with two dashes ?)
> +error: did you mean `--boolean` (with two dashes)?
>  EOF
>  
>  test_expect_success 'detect possible typos' '
> @@ -232,7 +232,7 @@ test_expect_success 'detect possible typos' '
>  '
>  
>  cat >typo.err <<\EOF
> -error: did you mean `--ambiguous` (with two dashes ?)
> +error: did you mean `--ambiguous` (with two dashes)?
>  EOF
>  
>  test_expect_success 'detect possible typos' '
>
> --
> https://github.com/git/git/pull/540
Previous: Jacques Bodin-HullinNext: Jacques Bodin-Hullin
Message 4 of 8 in “Typo `dashes ?` -> `dashes?`”
  1. Typo `dashes ?` -> `dashes?`Jacques Bodin-Hullin, Oct 14, 2018
  2. Jeff KingOct 15, 2018
  3. Change writing styleJacques Bodin-Hullin, Nov 16, 2018
  4. Junio C HamanoNov 17, 2018
  5. parse-options: lose an unnecessary space in an error messageJacques Bodin-Hullin, Feb 5, 2020
  6. Junio C HamanoFeb 5, 2020
  7. Jacques Bodin-HullinFeb 5, 2020
  8. Jeff KingOct 17, 2018

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.