[MERGE] [1.0] Move material out of User Guide into User Reference

Alexander Belchenko bialix at ukr.net
Tue Dec 11 16:34:08 GMT 2007


Aaron Bentley пишет:
> Alexander Belchenko wrote:
>>>> In this case this documentation should be built before tarball created.
>>> How can this documentation be built?  It already exists.  There's
>>> nothing to build.
>> I disagree. doc/en/user-reference/bzr_man.txt is auto-generated text.
>> And Ian's patch is all about this file. It's complete manual collecting
>> various text chunks from help topics and help for commands.
> 
> That is not the plaintext documentation that I am talking about.
> 
>>> Could you explain what you mean by "complete plaintext documentation"?
>> I mean that doc/en/user-reference/bzr_man.txt is complete plaintext
>> manual. I think it's almost the same as bzr.1 manpage, but I'm not sure.
>> But IIUC you're talking now not about manpage and html, but plaintext.
>> For me bzr_man.txt is essential part of bzr documentation set.
>> And when bzr_man.txt is properly generated it contains all texts you're
>> want to see in plain text.
>>
>> Does creating and packaging bzr_man.txt will satisfy your request to
>> have plaintext documentation in bzr sources tarball?
> 
> No.  I think that bzr_man.txt is very inconvenient to use.  For
> commandline help, "bzr help" is much nicer, because it allows you to
> quickly get to the information you're looking for.  For other
> documentation, having it broken down into separate files is much nicer,
> because it makes it easy to get just the information you're looking for.

Your requirements is mutually antithetic for me. You said you want to 
read plain text documentation in the favorite editor, that's why you 
don't want to read these topics in the console. But when I propose 
creating complete manual in the text format you said you prefer read 
help topics and help for commands in the console.



More information about the bazaar mailing list