Re: [PATCH 1/5] doc: git-diff: apply new documentation guidelines
- From
Patrick Steinhardt <ps@pks.im>
- Date
- Aug 6, 2024, 06:27 UTC
- Message-ID
- <ZrHCVmQvVH9MzpJ0@tanuki>
- In-Reply-To
- <5803739.DvuYhMxLoT@cayenne>
On Mon, Aug 05, 2024 at 08:51:21PM +0200, Jean-Noël AVILA wrote:
Show 25 quoted lines
> On Monday, 5 August 2024 11:11:07 CEST Patrick Steinhardt wrote: > > On Sun, Aug 04, 2024 at 08:05:32PM +0000, Jean-Noël Avila via GitGitGadget > wrote: > > > @@ -225,11 +225,12 @@ CONFIGURATION > > > > > > include::includes/cmd-config-section-all.txt[] > > > > > > +:git-diff: 1 > > > include::config/diff.txt[] > > > > > > SEE ALSO > > > -------- > > > -diff(1), > > > +`diff`(1), > > > > This one looks curious to me. Why is this item formatted differently > > than the next three? I would have expected it to be formatted as > > something like linkgit:git-diff[1] instead of `diff`(1)`. > > > > Here we are referring to the 'diff' command, not git-diff. That is why we don't > use the linkgit macro (which is used to generate cross links for html output). > > Still, the general format of a reference to a man-page is to put the command > name in bold, which our filters get by backquoting.
Oh, that makes sense of course. I totally forgot that there's a world outside of Git. Thanks for the clarification!
Patrick