new docs are not converted to html

Aaron Bentley aaron.bentley at utoronto.ca
Wed Sep 5 04:34:20 BST 2007


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

Ian Clatworthy wrote:
> Alexander Belchenko wrote:
>> There is 2 new txt files in directory doc\en\user-reference\
>> index.txt
>> hooks.txt
>>
>> They both are not converted to html during `make docs`.
> 
> Looking at your patch to fix this, I think that hooks.txt should be an
> online topic - part of bzrlib/help_topics.py - instead of a separate
> file. It will then automatically become part of the generated User
> Reference.

I don't think this is good.  The command reference should form a part of
the user reference, but we shouldn't be turning the bazaar executable
into its own user reference.  Ideally, the user reference would have
pages and pages of text on the user model, the merge algorithms, the
repository formats, etc.

The user reference should be a thick book.  Bazaar should not be a thick
book.  As I see it, help topics are supplements to the command help.

> There should be no special files in en/user-reference

Then why is it there?  I was shocked to find it empty.

Also, I should note that the Hook reference refers to the user guide,
which plays into the discussion of "more agressive error check for `make
docs`" in your other email.

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

iD8DBQFG3iO80F+nu1YWqI0RAigUAJ4twubVk53kbYR+MGZwvQpb4FxC1gCfZJ2t
/9J34ALDMjNFRhoSl2OeOyE=
=EiXJ
-----END PGP SIGNATURE-----



More information about the bazaar mailing list