Bug 30688 - generate manpages for "topgit" and tg-* cmds
Summary: generate manpages for "topgit" and tg-* cmds
Status: NEW
Alias: None
Product: Sisyphus
Classification: Development
Component: topgit (show other bugs)
Version: unstable
Hardware: all Linux
: P3 enhancement
Assignee: Ivan Zakharyaschev
QA Contact: qa-sisyphus
URL: https://github.com/greenrd/topgit/iss...
Keywords:
Depends on:
Blocks:
 
Reported: 2015-01-28 20:08 MSK by Ivan Zakharyaschev
Modified: 2016-05-23 09:02 MSK (History)
2 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Ivan Zakharyaschev 2015-01-28 20:08:51 MSK 
Debian has a long history of approaching this bug: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=499071 , but I'm not sure they actually have accepted one of the proposed patches.

* [There was a proposed patch](https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=499071#84) that makes the manpages be generated from the README and stuff. (With the help of asciidoc.) IMO, the patch is not perfect, because it adds the same boilerplate for each command described in the README, which makes it not quite readable.

* [There is another patch there](https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=499071#109), I haven't looked into it. It is said to require an external tool "ronn" not packaged in Debian.