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

Aaron Bentley aaron.bentley at utoronto.ca
Wed Dec 12 00:14:47 GMT 2007


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Ian Clatworthy wrote:
> Aaron Bentley wrote:
> 
>> That's certainly not the primary way I use the documentation.  I read
>> the plaintext.
>>
>>> * "bzr help topics" will display the information in their console if
>>>   they don't care to switch to a web browser
>> This won't allow them to read it in their viewer of choice.
> 
> Viewer yes, editor sometimes. There's always "bzr topic | vim -" for
> example.

Well, I certainly would include editors as a type of viewer.

>> That would improve matters, but not making this change at all would be
>> even better.  Bazaar isn't a gui app, so we shouldn't be treating
>> console-oriented users as second-class citizens.
> 
> I disagree. In no way does this patch treat console users as second
> class citizens. It *adds* topics into 'bzr help' they never had before
> and gives them a more extensive bzr_man.txt to search through in their
> favorite editor.

This is like saying "logging doesn't cut down trees, it gives you more
paper".  Both statements are true.

> If you think delivering plaintext doc in smaller pieces matters, I can
> generate files for each of the help topics individually in additional to
> the one big bzr_man.txt. I'm OK with that. But I honestly feel it is far
> lower priority than providing a single, comprehensive User Reference in
> HTML - something anyone with a web browser can search through and print.

Well, I'm a big "first, do no harm" kinda guy.

> Please reconsider the merits of this patch and consider our wider
> audience.

I still find the patch lacking, because there's no technical reason that
I can discover for moving the files.  Alexander reports "actual layout
of files don't affect me".

Aaron
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.6 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iD8DBQFHXyf20F+nu1YWqI0RAs5mAJ0SbjdyAcyHxVnd/u5VITK7R3OoLACeKTcr
pC6PMgR5kjWLc8mGXfy9KaE=
=Fev4
-----END PGP SIGNATURE-----



More information about the bazaar mailing list