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

[PATCH 1/4] notes doc: split up run-on sentences

From
Teng Long <dyroneteng@gmail.com>
Date
Aug 17, 2023, 02:22 UTC
Message-ID
<20230817022258.74357-1-tenglong.tl@alibaba-inc.com>
In-Reply-To
<a8e5a98da5f577fc6235bff07d7430377344dd93.1692194193.git.martin.agren@gmail.com>
Show 38 quoted lines
> "Martin Ågren" <martin.agren@gmail.com> writes:
> 
> When commit c4e2aa7d45 (notes.c: introduce "--[no-]stripspace" option,
> 2023-05-27) mentioned the new `--no-stripspace` in the documentation for
> `-m` and `-F`, it created run-on sentences. It also used slightly
> different language in the two sections for no apparent reason. Split the
> sentences in two to improve readability, and while touching the two
> sites, make them more similar.
> 
> Signed-off-by: Martin Ågren <martin.agren@gmail.com>
> ---
>  Documentation/git-notes.txt | 9 ++++-----
>  1 file changed, 4 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
> index bc1bfa3791..9043274ce8 100644
> --- a/Documentation/git-notes.txt
> +++ b/Documentation/git-notes.txt
> @@ -141,17 +141,16 @@ OPTIONS
>  	If multiple `-m` options are given, their values
>  	are concatenated as separate paragraphs.
>  	Lines starting with `#` and empty lines other than a
> -	single line between paragraphs will be stripped out,
> -	if you wish to keep them verbatim, use `--no-stripspace`.
> +	single line between paragraphs will be stripped out.
> +	If you wish to keep them verbatim, use `--no-stripspace`.
>  
>  -F <file>::
>  --file=<file>::
>  	Take the note message from the given file.  Use '-' to
>  	read the note message from the standard input.
>  	Lines starting with `#` and empty lines other than a
> -	single line between paragraphs will be stripped out,
> -	if you wish to keep them verbatim, use with
> -	`--no-stripspace` option.
> +	single line between paragraphs will be stripped out.
> +	If you wish to keep them verbatim, use `--no-stripspace`.
>  
LGTM.
Thanks for catching and fixing these docs.
>  -C <object>::
>  --reuse-message=<object>::
> -- 
> 2.42.0.rc2.215.g538df5cf27
Thanks
Previous: Martin ÅgrenNext: Martin Ågren
Message 3 of 12 in “some doc fixes on v2.42.0-rc2”
  1. 0/4 some doc fixes on v2.42.0-rc2Martin Ågren, Aug 16, 2023
  2. 1/4 notes doc: split up run-on sentencesMartin Ågren, Aug 16, 2023
  3. 1/4 notes doc: split up run-on sentencesTeng Long, Aug 17, 2023
  4. 4/4 rev-list-options: fix typo in `--stdin` documentationMartin Ågren, Aug 16, 2023
  5. Junio C HamanoAug 16, 2023
  6. Junio C HamanoAug 16, 2023
  7. Martin ÅgrenAug 17, 2023
  8. 2/4 notes doc: tidy up `--no-stripspace` paragraphMartin Ågren, Aug 16, 2023
  9. 2/4 notes doc: tidy up `--no-stripspace` paragraphTeng Long, Aug 17, 2023
  10. Martin ÅgrenAug 17, 2023
  11. 3/4 show-ref doc: fix carets in monospaceMartin Ågren, Aug 16, 2023
  12. Junio C HamanoAug 16, 2023

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.