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