Bug #3890
man pages -- missing sources
| Status: | Closed | Start date: | 07/27/2015 | |
|---|---|---|---|---|
| Priority: | High | Due date: | ||
| Assignee: |  Javi Fontan | % Done: | 0% | |
| Category: | Documentation | |||
| Target version: | - | |||
| Resolution: | wontfix | Pull request: | ||
| Affected Versions: | OpenNebula 4.12 |
Description
Man pages in "share/man" are "generated with Ronn/v0.7.3" but their sources are missing.
History
#1
Updated by Javi Fontan almost 6 years ago
The source for man pages is the command help. That is, calling the command with --help. For example:
$ onevm --help > onevm.1.ronn $ ronn --style toc onevm.1.ronn
ronn command can be installed with rubygems:
$ gem install ronn
#2
Updated by Dmitry Smirnov almost 6 years ago
Thank you. Any ideas how can I (re-)build all man pages on build time?
#3
Updated by Dmitry Smirnov almost 6 years ago
Perhaps it might be a good idea to remove "generated" headers so those man pages could be improved without risk of loosing changes...
#4
Updated by OpenNebula Systems Support Team almost 6 years ago
Currently the man pages are regenerated manually for each new version. This is done like this as there is not an easy way to do it and to not add extra build dependencies (ronn and help2man).
#5
Updated by Javi Fontan almost 6 years ago
- Status changed from Pending to Closed
- Assignee set to Javi Fontan
- Resolution set to wontfix