Re: Are the 'How to' documents present as man pages?

From: Simon Ruderich <simon@ruderich.org>
Date: Sep 16, 2017, 08:54 UTC
Message-ID: <20170916085402.pc2vnimymien355n@ruderich.org>
In-Reply-To: <1505538043.21890.4.camel@gmail.com>

On Sat, Sep 16, 2017 at 10:30:43AM +0530, Kaartic Sivaraam wrote:

Show 9 quoted lines

> I was reading the 'git revert' documentation and found the following
> line in it,
>
>     -m parent-number
>     --mainline parent-number
>
>         ...
>
>         See the revert-a-faulty-merge How-To[1] for more details.

Square brackets indicate links, you should have a NOTES section at the bottom of the man page which contains something like this:

        1. revert-a-faulty-merge How-To
           file:///usr/share/doc/git/html/howto/revert-a-faulty-merge.html

To my knowledge those are not available as man pages.

> It says that the 'How-To' is present in the first section of the man
> page. I tried to access it to get this,

References to other man pages generally use round brackets, for example git-merge(1).

I checked the git-scm.com website [1] and interestingly they use square brackets for these references which confused me a little. Not sure if it's worth changing though.

Regards Simon

[1]: https://git-scm.com/docs/git-revert

-- 
+ privacy is necessary
+ using gnupg http://gnupg.org
+ public key id: 0x92FEFDB7E44C32F9