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

Re: [PATCH v2] git-rebase.txt: use back-ticks consistently

From
PWPhillip Wood <phillip.wood123@gmail.com>
Date
Jun 29, 2022, 09:27 UTC
Message-ID
<35e1e681-2666-a7fd-9b30-05a78ae9e957@gmail.com>
In-Reply-To
<pull.1270.v2.git.1656446577611.gitgitgadget@gmail.com>
On 28/06/2022 21:02, Derrick Stolee via GitGitGadget wrote:
Show 22 quoted lines
> From: Derrick Stolee <derrickstolee@github.com>
> 
> While inspecting the 'git rebase' documentation, I noticed that it is
> inconsistent with how it uses back-ticks (or other punctuation) for
> identifying Git commands, command-line arguments, or values for those
> arguments.
> 
> Sometimes, an argument (like '--interactive') would appear without any
> punctuation, causing the argument to not have any special formatting.
> Other times, arguments or 'git rebase' itself would have single-quotes
> giving a bold look (in the HTML documentation at least).
> 
> By consistently using back-ticks, these types of strings appear in a
> monospace font with special highlighting to appear more clearly as text
> that exists in a command-line invocation of a Git command.
> 
> This rather-large diff is the result of scanning git-rebase.txt and
> adding back-ticks as appropriate. Some are adding back-ticks where there
> was no punctuation. Others are replacing single quotes.
> 
> There are also a few minor cleanups in the process, including those
> found by reviwers.
Not worth a re-roll on its own: s/reviwers/reviewers/
> 
> Helped-by: Phillip Wood <phillip.wood123@gmail.com>
> Helped-by: Junio C Hamano <gitster@pobox.com>
> Signed-off-by: Derrick Stolee <derrickstolee@github.com>
This is looking good, I've one minor comment below
Show 5 quoted lines
> -git rebase has two primary backends: apply and merge.  (The apply
> -backend used to be known as the 'am' backend, but the name led to
> -confusion as it looks like a verb instead of a noun.  Also, the merge
> +`git rebase` has two primary backends: 'apply' and 'merge'.  (The 'apply'
> +backend used to be known as the `am` backend, but the name led to

I think we should keep single quotes around "am" as it is being used as a name like 'apply'

Thanks again for cleaning up the documentation
Phillip
Previous: Derrick StoleeNext: Derrick Stolee
Message 15 of 19 in “git-rebase.txt: use back-ticks consistently”
  1. git-rebase.txt: use back-ticks consistentlyDerrick Stolee via GitGitGadget, Jun 27, 2022
  2. Phillip WoodJun 28, 2022
  3. Derrick StoleeJun 28, 2022
  4. Ævar Arnfjörð BjarmasonJun 28, 2022
  5. Rendering back-ticks in plaintext docs (was Re: [PATCH] git-rebase.txt: use back-ticks consistently)Derrick Stolee, Jun 28, 2022
  6. Junio C HamanoJun 28, 2022
  7. Junio C HamanoJun 28, 2022
  8. Derrick StoleeJun 28, 2022
  9. git-rebase.txt: use back-ticks consistentlyDerrick Stolee via GitGitGadget, Jun 28, 2022
  10. Junio C HamanoJun 28, 2022
  11. Phillip WoodJun 29, 2022
  12. Derrick StoleeJun 29, 2022
  13. Junio C HamanoJun 30, 2022
  14. Derrick StoleeJun 29, 2022
  15. Phillip WoodJun 29, 2022
  16. Derrick StoleeJun 29, 2022
  17. git-rebase.txt: use back-ticks consistentlyDerrick Stolee via GitGitGadget, Jun 29, 2022
  18. Phillip WoodJun 29, 2022
  19. Junio C HamanoJun 30, 2022

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.