[RFC/PATCH] Writing hooks doc

[Andrew Bennetts]

Hi,

This patch isn't complete, but I thought I should send what I had and get some
early feedback.  It adds some text to the User Guide to explain in more detail
how to write a useful hook.

I used my experience with writing the example GNOME pre_change_branch_tip hooks
as a guide.

Things I'm not fully satisfied with:

 * all the XXXs :)
 * particularly the XXX about terminology: “hook” vs. “hook function”
 * I'm not sure if the User Guide is the best place for this doc, but the admin
   guide is just a stub at the moment.
 * the “Getting the contents of a file at some revision” section is pretty
   messy.  I think ideally we'd just have a simpler API rather than a doc
   explaining how to deal with a complicated one that is easy to get wrong.

So this isn't really ready for merging, but I wanted to get some feedback.

-Andrew.

-------------- next part --------------
A non-text attachment was scrubbed...
Name: writing-hook-docs.patch
Type: text/x-diff
Size: 14093 bytes
Desc: not available
Url : https://lists.ubuntu.com/archives/bazaar/attachments/20080723/504d6b3d/attachment.bin