[MERGE REQUEST] New manpage setup

[James Blackwell]

On Tue, Jan 03, 2006 at 06:37:55PM -0600, John Arbash Meinel wrote:
> James Blackwell wrote:
> > branch: http://mercury.merconline.com/~jblack/branches/bzr-help
> > contents: New manpage generation code, trivial doc updates
> > 
> > 
> 
> Can you give more of a summary? Does this change how the man page is
> created? Like having it created from the doc strings?
> 
> There were a lot of short comments to try and figure out what really
> changed.

Heh. More description is appropriate.  This modification does the following: 

 * Rewrites the manpage generator (which pulled from doc strings as well)
   to pull more documentation from the commands. Instead of just providing
   one line summaries, the whole docstring in presented. 


 * Includes the wiring to build other things as well, such as bash and
   zshell completion, again off of the command information.


By way of comparision: 
mainline: 
...
COMMAND OVERVIEW:
  bzr check [BRANCH]
      Validate consistancy of branch history.
...



bzr-help: 

...[other part of manpage]

COMMAND OVERVIEW:
  bzr check [BRANCH]
      Validate consistancy of branch history.
...[other command overviews]...

COMMAND REFERENCE:
   bzr check [BRANCH]
       Options:
           --help, -h                show help message
           --verbose, -v             display more information

       Validate consistency of branch history.

       This  command  checks  various  invariants  about the branch storage to
       detect data corruption or bzr bugs.

...[other command references, etc]

      

> 
> John
> =:->



-- 
James Blackwell's home :  http://jblack.linuxguru.net
Gnupg 06357400   F-print AAE4 8C76 58DA 5902 761D  247A 8A55 DA73 0635 7400
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
Url : https://lists.ubuntu.com/archives/bazaar/attachments/20060103/739243ba/attachment.pgp