[distcc] Improvement for the documentation of the monitoring interface

[Martin Pool]

On 29 Sep 2003, Frerich Raabe <raabe at kde.org> wrote:
> Moin,
> 
> the attached patch improves the documentation of the interface which distcc 
> provides to let people write monitoring software for distcc cluster. The 
> patch consists of a tiny fix to the API documentation in state.h, and an 
> appendix chapter to the manual which hopefully gives a helpful introduction 
> for people interested in writing monitors for distcc clusters.

Thankyou for writing this.  I'll go through and check it.

I dropped the Linuxdoc manual a few releases ago out of annoyance at
its non-portability and now we just have manpages.  I can add your
text to either the .h file, or a text file in the doc/ directory.

> Note that the appendix chapter is likely to be incomplete, I only documented 
> the parts which I deemed useful for people pondering to write distcc 
> monitors, and which I used myself. It would be nice of people could proofread 
> the patch, and improve it where necessary.
> 
> Committing this patch makes it easier for people to develop software for 
> distcc, which is IMHO a goal worth aiming for. I for one wished I had some 
> kind of introduction like this when I wrote my distcc monitor.

OK.

-- 
Martin