Re: [PATCH 6/6] doc: git-clone: format placeholders
- From
Jean-Noël Avila <avila.jn@gmail.com>
- Date
- Mar 11, 2024, 21:43 UTC
- Message-ID
- <3c98b049-4eb8-4441-aae7-4789a8f74d9b@gmail.com>
- In-Reply-To
- <xmqqbk7ku2ak.fsf@gitster.g>
Le 11/03/2024 à 18:05, Junio C Hamano a écrit :
Show 13 quoted lines
> "Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com> writes: > >> --bare:: >> Make a 'bare' Git repository. That is, instead of >> - creating `<directory>` and placing the administrative >> - files in `<directory>/.git`, make the `<directory>` >> + creating _<directory>_ and placing the administrative >> + files in `<directory>/.git`, make the _<directory>_ > > It is hard to decide what the right thing to do is to the earlier > one on this line, isn't it? It is not fully verbatim, even though > its "/.git" part is. >
Like the synopsys of the manpages, if there is a "constant" part in the word, it is deemed to be verbatim. Only when the placeholder is standing alone (usually the sentence is about it) must the placeholder be marked up as emphasized.
Also, headers of description list needn't be marked up.
Maybe worth some additional rules in the guidelines...
> Everything else in this entire series looked good to my cursory > read, but I'd appreciate extra sets of eyes, of course. > > Thanks for working on this topic.
There are manpages that are really inconsistant, and even malformed (such as gitremote-helpers), but the order of fixing will be to focus on the most often viewed ones first.