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

Re: [PATCH v2 2/3] git-submodule.txt: make subcommands underlined

From
Duy Nguyen <pclouds@gmail.com>
Date
Feb 13, 2019, 09:55 UTC
Message-ID
<CACsJy8A2M2vc36OLN9jMt3tPq+AwNquyxjrdQXQ7zNZ8pAjTSQ@mail.gmail.com>
In-Reply-To
<20190213081518.GA21926@archbookpro.localdomain>
On Wed, Feb 13, 2019 at 3:15 PM Denton Liu <liu.denton@gmail.com> wrote:
Show 14 quoted lines
>
> On Tue, Feb 12, 2019 at 01:56:11AM -0800, Denton Liu wrote:
> > In git-remote.txt, the subcommands are underlined. Following that, we
> > also underline the subcommands in git-submodule.txt.
>
> I'd like to retract this patch. I realised that between git-remote,
> git-submodule, git-notes, git-stash, git-bisect, git-reflog, it's pretty
> inconsistent between whether it's formatted with the underline or not.
>
> Also, I missed the underlining of the subcommands in the body of the
> document.
>
> But if someone thinks that unifying the formatting is a worthwhile
> pursuit, I'd be happy to reroll this patchset to include this fix.

Making documents look consistent is always good, I think. If you want to do this, maybe have a look at the "Writing Documentation" section in CodingGuidelines and add a note there too, about quoting subcommand names.

-- 
Duy
Previous: Denton LiuNext: Junio C Hamano
Message 7 of 14 in “git-submodule.txt: document default behavior”
  1. git-submodule.txt: document default behaviorDenton Liu, Feb 12, 2019
  2. Duy NguyenFeb 12, 2019
  3. 0/3 Document git-submodule's default behaviorDenton Liu, Feb 12, 2019
  4. 1/3 git-remote.txt: be specific about default behaviorDenton Liu, Feb 12, 2019
  5. 2/3 git-submodule.txt: make subcommands underlinedDenton Liu, Feb 12, 2019
  6. Denton LiuFeb 13, 2019
  7. Duy NguyenFeb 13, 2019
  8. Junio C HamanoFeb 13, 2019
  9. 3/3 submodule: document default behaviorDenton Liu, Feb 12, 2019
  10. Junio C HamanoFeb 13, 2019
  11. Denton LiuFeb 14, 2019
  12. Junio C HamanoFeb 14, 2019
  13. 0/1 Document git-submodule's default behaviorDenton Liu, Feb 15, 2019
  14. 1/1 submodule: document default behaviorDenton Liu, Feb 15, 2019

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.