{"thread":{"id":"46762","subject":"Are the 'How to' documents present as man pages?","startedAt":"2017-09-16T05:00:58Z","lastAt":"2017-09-16T12:05:37Z","messageCount":4,"participants":["Kaartic Sivaraam","Simon Ruderich"],"isPatch":false,"patchVersion":null,"patchTotal":null},"messages":[{"id":"328182","messageId":"1505538043.21890.4.camel@gmail.com","threadId":"46762","inReplyTo":null,"subject":"Are the 'How to' documents present as man pages?","fromName":"Kaartic Sivaraam","fromEmail":"kaarticsivaraam91196@gmail.com","sentAt":"2017-09-16T05:00:43Z","receivedAt":"2017-09-16T05:00:58Z","isPatch":false,"sender":{"key":"kaartic.sivaraam@gmail.com","avatar":"https://avatars.githubusercontent.com/u/12448084?v=4"},"body":"I was reading the 'git revert' documentation and found the following\nline in it,\n\n\n    -m parent-number\n    --mainline parent-number\n\n        ...\n\n        See the revert-a-faulty-merge How-To[1] for more details.\n\n\nIt says that the 'How-To' is present in the first section of the man\npage. I tried to access it to get this,\n\n\n    $ man 1 revert-a-faulty-merge How-To\n    No manual entry for revert-a-faulty-merge in section 1\n    No manual entry for How-To in section 1\n\n\nThat made me wonder whether the 'How-To' documents were present as man\npages and were installed when git is installed.\n\nIn case they are, how should I be accessing them? In case they aren't\ndoesn't the above seem misleading?\n\n\n    -- \n    Kaartic\n"},{"id":"328228","messageId":"20170916085402.pc2vnimymien355n@ruderich.org","threadId":"46762","inReplyTo":"1505538043.21890.4.camel@gmail.com","subject":"Re: Are the 'How to' documents present as man pages?","fromName":"Simon Ruderich","fromEmail":"simon@ruderich.org","sentAt":"2017-09-16T08:54:02Z","receivedAt":"2017-09-16T08:54:10Z","isPatch":false,"sender":{"key":"simon@ruderich.org","avatar":"https://avatars.githubusercontent.com/u/390994?v=4"},"body":"On Sat, Sep 16, 2017 at 10:30:43AM +0530, Kaartic Sivaraam wrote:\n> I was reading the 'git revert' documentation and found the following\n> line in it,\n>\n>     -m parent-number\n>     --mainline parent-number\n>\n>         ...\n>\n>         See the revert-a-faulty-merge How-To[1] for more details.\n\nSquare brackets indicate links, you should have a NOTES section\nat the bottom of the man page which contains something like this:\n\n        1. revert-a-faulty-merge How-To\n           file:///usr/share/doc/git/html/howto/revert-a-faulty-merge.html\n\nTo my knowledge those are not available as man pages.\n\n> It says that the 'How-To' is present in the first section of the man\n> page. I tried to access it to get this,\n\nReferences to other man pages generally use round brackets, for\nexample git-merge(1).\n\nI checked the git-scm.com website [1] and interestingly they use\nsquare brackets for these references which confused me a little.\nNot sure if it's worth changing though.\n\nRegards\nSimon\n\n[1]: https://git-scm.com/docs/git-revert\n-- \n+ privacy is necessary\n+ using gnupg http://gnupg.org\n+ public key id: 0x92FEFDB7E44C32F9\n"},{"id":"328231","messageId":"1505562455.23153.3.camel@gmail.com","threadId":"46762","inReplyTo":"20170916085402.pc2vnimymien355n@ruderich.org","subject":"Re: Are the 'How to' documents present as man pages?","fromName":"Kaartic Sivaraam","fromEmail":"kaarticsivaraam91196@gmail.com","sentAt":"2017-09-16T11:47:35Z","receivedAt":"2017-09-16T11:59:57Z","isPatch":false,"sender":{"key":"kaartic.sivaraam@gmail.com","avatar":"https://avatars.githubusercontent.com/u/12448084?v=4"},"body":"On Sat, 2017-09-16 at 10:54 +0200, Simon Ruderich wrote:\n> On Sat, Sep 16, 2017 at 10:30:43AM +0530, Kaartic Sivaraam wrote:\n> > I was reading the 'git revert' documentation and found the following\n> > line in it,\n> > \n> >     -m parent-number\n> >     --mainline parent-number\n> > \n> >         ...\n> > \n> >         See the revert-a-faulty-merge How-To[1] for more details.\n> \n> Square brackets indicate links, you should have a NOTES section\n> at the bottom of the man page which contains something like this:\n> \n\nYes there is, thanks!\n\n> References to other man pages generally use round brackets, for\n> example git-merge(1).\n> \n\nI didn't know they had different meanings for different brackets in man\npages. The asciidoc source itself uses square-brackets to refer to man\npage sections. May the link to notes should be something like [note 1].\nNot sure if it's possible to do that.\n\n---\nKaartic\n"},{"id":"328232","messageId":"20170916120531.qbtffov6gwjbom3m@ruderich.org","threadId":"46762","inReplyTo":"1505562455.23153.3.camel@gmail.com","subject":"Re: Are the 'How to' documents present as man pages?","fromName":"Simon Ruderich","fromEmail":"simon@ruderich.org","sentAt":"2017-09-16T12:05:31Z","receivedAt":"2017-09-16T12:05:37Z","isPatch":false,"sender":{"key":"simon@ruderich.org","avatar":"https://avatars.githubusercontent.com/u/390994?v=4"},"body":"On Sat, Sep 16, 2017 at 05:17:35PM +0530, Kaartic Sivaraam wrote:\n>> References to other man pages generally use round brackets, for\n>> example git-merge(1).\n>\n> I didn't know they had different meanings for different brackets in man\n> pages. [snip]\n\nMan pages in general use only round brackets to refer to another\nman page with the given section (like stat(1) or stat(2)).\n\nSquare brackets have no special meaning, but are useful for\nreferences like URLs.\n\nRegards\nSimon\n-- \n+ privacy is necessary\n+ using gnupg http://gnupg.org\n+ public key id: 0x92FEFDB7E44C32F9\n"}]}