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

Re: [PATCH 1/5] doc: convert git-reset to new documentation format

From
MÅMartin Ågren <martin.agren@gmail.com>
Date
Apr 4, 2025, 16:39 UTC
Message-ID
<CAN0heSpQVWEko_=Ld1yQvduH4amB+Ei8Gf2pOjWA1Y4Pq7GSKA@mail.gmail.com>
In-Reply-To
<1676b5ac628fd2898c3dab1b25d6a852cedfa6ae.1743354964.git.gitgitgadget@gmail.com>
Hi Jean-Noël,

On Sun, 30 Mar 2025 at 19:16, Jean-Noël Avila via GitGitGadget <gitgitgadget@gmail.com> wrote:

Show 6 quoted lines
> - Switch the synopsis to a synopsis block which will automatically
>   format placeholders in italics and keywords in monospace
> - Use _<placeholder>_ instead of <placeholder> in the description
> - Use `backticks` for keywords and more complex option
> descriptions. The new rendering engine will apply synopsis rules to
> these spans.
Show 8 quoted lines
> ---soft::
> +`--soft`::
>         Does not touch the index file or the working tree at all (but
> -       resets the head to `<commit>`, just like all modes do). This leaves
> -       all your changed files "Changes to be committed", as `git status`
> +       resets the head to _<commit>_, just like all modes do). This leaves
> +       all your changed files "Changes to be committed", as `git status
>         would put it.
This loses the closing backtick after "git status".
Show 18 quoted lines
> ---pathspec-from-file=<file>::
> -       Pathspec is passed in `<file>` instead of commandline args. If
> -       `<file>` is exactly `-` then standard input is used. Pathspec
> -       elements are separated by LF or CR/LF. Pathspec elements can be
> +`--pathspec-from-file=<file>`::
> +       Pathspec is passed in _<file>_ instead of commandline args. If
> +       _<file>_ is exactly `-` then standard input is used. Pathspec
> +       elements are separated by _LF_ or _CR_/_LF_. Pathspec elements can be
>         quoted as explained for the configuration variable `core.quotePath`
>         (see linkgit:git-config[1]). See also `--pathspec-file-nul` and
>         global `--literal-pathspecs`.
>
> ---pathspec-file-nul::
> +`--pathspec-file-nul`::
>         Only meaningful with `--pathspec-from-file`. Pathspec elements are
> -       separated with NUL character and all other characters are taken
> +       separated with _NUL_ character and all other characters are taken
>         literally (including newlines and quotes).

I was surprised that you wrapped CR, LF, and NUL in underscores. The commit message only talks about <placeholders>, similar to CodingGuidelines. That said, these _CR_ and friends seem to be consistent with similar conversions you've done before.

Martin
Previous: Jean-Noël Avila via GitGitGadgetNext: Jean-Noël Avila via GitGitGadget
Message 3 of 19 in “doc: convert git-reset, git-rm and git-mv to new documentation format”
  1. 0/5 doc: convert git-reset, git-rm and git-mv to new documentation formatJean-Noël Avila via GitGitGadget, Mar 30, 2025
  2. 1/5 doc: convert git-reset to new documentation formatJean-Noël Avila via GitGitGadget, Mar 30, 2025
  3. Martin ÅgrenApr 4, 2025
  4. 2/5 doc: fix synopsis analysis logicJean-Noël Avila via GitGitGadget, Mar 30, 2025
  5. Martin ÅgrenApr 4, 2025
  6. Jean-Noël AvilaApr 12, 2025
  7. 3/5 doc: convert git-rm to new documentation formatJean-Noël Avila via GitGitGadget, Mar 30, 2025
  8. 4/5 doc: move synopsis git-mv commands in the synopsis sectionJean-Noël Avila via GitGitGadget, Mar 30, 2025
  9. Martin ÅgrenApr 5, 2025
  10. 5/5 doc: convert git-mv to new documentation formatJean-Noël Avila via GitGitGadget, Mar 30, 2025
  11. 0/7 doc: convert git-reset, git-rm and git-mv to new documentation formatJean-Noël Avila via GitGitGadget, Apr 12, 2025
  12. 1/7 doc: convert git-reset to new documentation formatJean-Noël Avila via GitGitGadget, Apr 12, 2025
  13. 2/7 doc: fix synopsis analysis logicJean-Noël Avila via GitGitGadget, Apr 12, 2025
  14. 3/7 doc: convert git-rm to new documentation formatJean-Noël Avila via GitGitGadget, Apr 12, 2025
  15. 4/7 doc: move synopsis git-mv commands in the synopsis sectionJean-Noël Avila via GitGitGadget, Apr 12, 2025
  16. 5/7 doc: convert git-mv to new documentation formatJean-Noël Avila via GitGitGadget, Apr 12, 2025
  17. 6/7 doc: fix asciidoctor synopsis processing of triple-dotsJean-Noël Avila via GitGitGadget, Apr 12, 2025
  18. 7/7 doc: add markup for characters in GuidelinesJean-Noël Avila via GitGitGadget, Apr 12, 2025
  19. Junio C HamanoApr 14, 2025

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.