>>>>> "eric" == Eric Bollengier <[email protected]> writes:
eric> Le mercredi 20 janvier 2010 16:16:28, Phil Stracchino a écrit :
>> I suggest that the documentation needs a single complete
>> Configuration Reference appendix that goes through each of
>> the possible configuration files (bacula-dir.conf,
>> bacula-fd.conf, bacula-sd.conf, bconsole.conf, bat.conf)
>> listing every resource that can exist in that file and
>> every directive that is legal - and every directive that
>> is *required* - in each resource in that file.
...
eric> It's true, most of the time, to find an option or the
eric> default value, I open dird_conf.c or
eric> stored_conf.c. This is a good idea, so patches and FLA
eric> are welcome. Be sure to work on the current master
eric> branch, else it will be very hard to integrate changes.
Eric's observation made me think of another suggestion, though
one that would be a lot of work (and I'm not in a position to help
anytime soon)...
Would it be worthwhile to actually store the resource
descriptions in the *_conf.c files (within comments or maybe even
as part of bacula's runtime help), and then extract those
descriptions to build the documentation? (Something like how
javadoc pulls the API descriptions out of Java source file
comments.)
Doing so might help prevent divergence between the code and the
documentation as people add new resources or modify the
interpretation of existing ones.
------------------------------------------------------------------------------
Throughout its 18-year history, RSA Conference consistently attracts the
world's best and brightest in the field, creating opportunities for Conference
attendees to learn about information security's most important issues through
interactions with peers, luminaries and emerging and established companies.
http://p.sf.net/sfu/rsaconf-dev2dev
_______________________________________________
Bacula-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/bacula-devel
