git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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

From
Kaartic Sivaraam <kaarticsivaraam91196@gmail.com>
Date
Sep 16, 2017, 11:47 UTC
Message-ID
<1505562455.23153.3.camel@gmail.com>
In-Reply-To
<20170916085402.pc2vnimymien355n@ruderich.org>
On Sat, 2017-09-16 at 10:54 +0200, Simon Ruderich wrote:
Show 14 quoted lines
> 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

Previous: Simon RuderichNext: Simon Ruderich
Message 3 of 4 in “Are the 'How to' documents present as man pages?”
  1. Kaartic SivaraamSep 16, 2017
  2. Simon RuderichSep 16, 2017
  3. Kaartic SivaraamSep 16, 2017
  4. Simon RuderichSep 16, 2017

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.