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

Re: [PATCH 3/4] doc: git-init: apply new documentation formatting guidelines

From
Jean-Noël AVILA <jn.avila@free.fr>
Date
Mar 26, 2024, 20:26 UTC
Message-ID
<12408886.O9o76ZdvQC@cayenne>
In-Reply-To
<CAN0heSpVLAw3iYiCcgTnOtO9saY0KXR+00r7mR-PfqU+EcfPoA@mail.gmail.com>
Le mardi 26 mars 2024, 21:18:31 CET Martin Ågren a écrit :
Show 25 quoted lines
> On Sun, 24 Mar 2024 at 23:19, Jean-Noël Avila via GitGitGadget
> <gitgitgadget@gmail.com> wrote:
> > -umask::
> > -false::
> > +`umask`::
> > +`false`::
> 
> (It should be `umask` here exactly as you did, ok, good.)
> 
> >  Use permissions reported by umask(2). The default, when `--shared` is not
> >  specified.
> 
> >  _<perm>_ is a 3-digit octal number prefixed with `0` and each file
> >  will have mode _<perm>_. _<perm>_ will override users'`umask(2)`
> 
> It's a bit of a mix whether umask(2) should be `umask(2)` with backticks
> or just umask(2) without. That's pretty much the only thing I noticed,
> everything else looks really nice and consistent. I guess it's not a
> literal, since we don't expect to user to actually type the 8 characters
> "umask(2)"? If you do decide to drop the backticks, notice that there's
> one instance (seen above) of "users'`umask(2)`" with a missing space,
> so you might want to fix that up at the same time.
> 
> Martin
> 

Ah. Good point! As we are referring to the manpage of a function, this *is* indeed a case of verbatim text so, it must be backquoted.

So, I'll add it the guidelines and reroll with changes in the man pages.
Thanks
Previous: Martin ÅgrenNext: Jean-Noël Avila via GitGitGadget
Message 8 of 21 in “Doc new guidelines”
  1. 0/4 Doc new guidelinesJean-Noël Avila via GitGitGadget, Mar 24, 2024
  2. 1/4 doc: rework CodingGuidelines with new formatting rulesJean-Noël Avila via GitGitGadget, Mar 24, 2024
  3. 2/4 doc: allow literal and emphasis format in doc vs help testsJean-Noël Avila via GitGitGadget, Mar 24, 2024
  4. Jeff KingMar 28, 2024
  5. Eric SunshineMar 28, 2024
  6. 3/4 doc: git-init: apply new documentation formatting guidelinesJean-Noël Avila via GitGitGadget, Mar 24, 2024
  7. Martin ÅgrenMar 26, 2024
  8. Jean-Noël AVILAMar 26, 2024
  9. 4/4 doc: git-clone: apply new documentation guidelinesJean-Noël Avila via GitGitGadget, Mar 24, 2024
  10. Martin ÅgrenMar 26, 2024
  11. Junio C HamanoMar 26, 2024
  12. Jean-Noël AVILAMar 26, 2024
  13. Junio C HamanoMar 26, 2024
  14. 0/5 Doc new guidelinesJean-Noël Avila via GitGitGadget, Mar 29, 2024
  15. 1/5 doc: rework CodingGuidelines with new formatting rulesJean-Noël Avila via GitGitGadget, Mar 29, 2024
  16. Eric SunshineMar 29, 2024
  17. Jean-Noël AVILAMar 30, 2024
  18. 2/5 doc: allow literal and emphasis format in doc vs help testsJean-Noël Avila via GitGitGadget, Mar 29, 2024
  19. 3/5 doc: git-init: apply new documentation formatting guidelinesJean-Noël Avila via GitGitGadget, Mar 29, 2024
  20. 5/5 doc: git-clone: do not autoreference the manpage in itselfJean-Noël Avila via GitGitGadget, Mar 29, 2024
  21. 4/5 doc: git-clone: apply new documentation formatting guidelinesJean-Noël Avila via GitGitGadget, Mar 29, 2024

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.