From: Kaartic Sivaraam <kaarticsivaraam91196@gmail•com>
To: Simon Ruderich <simon@ruderich•org>
Cc: git@vger•kernel.org
Subject: Re: Are the 'How to' documents present as man pages?
Date: Sat, 16 Sep 2017 17:17:35 +0530 [thread overview]
Message-ID: <1505562455.23153.3.camel@gmail.com> (raw)
In-Reply-To: <20170916085402.pc2vnimymien355n@ruderich.org>
On Sat, 2017-09-16 at 10:54 +0200, Simon Ruderich wrote:
> On Sat, Sep 16, 2017 at 10:30:43AM +0530, Kaartic Sivaraam wrote:
> > 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:
>
Yes there is, thanks!
> References to other man pages generally use round brackets, for
> example git-merge(1).
>
I didn't know they had different meanings for different brackets in man
pages. The asciidoc source itself uses square-brackets to refer to man
page sections. May the link to notes should be something like [note 1].
Not sure if it's possible to do that.
---
Kaartic
next prev parent reply other threads:[~2017-09-16 11:59 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-09-16 5:00 Are the 'How to' documents present as man pages? Kaartic Sivaraam
2017-09-16 8:54 ` Simon Ruderich
2017-09-16 11:47 ` Kaartic Sivaraam [this message]
2017-09-16 12:05 ` Simon Ruderich
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1505562455.23153.3.camel@gmail.com \
--to=kaarticsivaraam91196@gmail$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=simon@ruderich$(echo .)org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox