Frans writes:

> I've been looking at some documentation issues, but have a question before I
> proceed and start submitting patches.
> 
> Is it correct that /doc/BackupPC.html is generated before release from
> /doc/BackupPC.pod using 'pod2html'?

Yes.

> If so, I guess I only need to submit patches for BackupPC.pod, correct?

Yes.  The real source is the CVS version, prior to running makeDist.

The makeDist script merges the config file comments into BackupPC.pod
(by replacing the tags __CONFIGPOD__, __VERSION__, __RELEASEDATE__)
to create the BackupPC.pod and BackupPC.html in the tarball.

The configure.pl script in turn replaces various tags like __TOPDIR__
in BackupPC.pod and BackupPC.html with their installation-dependent
values (so the local documentation reflects the paths in the local
installation).

If you have changes to the config comments (which ends up in the
documentation) you should send diffs to CVS conf/config.pl.

> Other general question: do you prefer lots of small patches or would you
> rather have similar changes grouped together in one larger patch? For
> potentially controversial changes I would of course use separate patches.

Provided the changes aren't controversial, one large patch off the mainline
CVS is ideal.  I agree that you should make a seperate patch for significant
or controversial changes.

Craig

-------------------------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems?  Stop.
Now Search log events and configuration files using AJAX and a browser.
Download your FREE copy of Splunk now >>  http://get.splunk.com/
_______________________________________________
BackupPC-devel mailing list
BackupPC-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/backuppc-devel
http://backuppc.sourceforge.net/

Reply via email to