On 11/11/2011 7:19 PM, David Mertens wrote:
Chris -

Some quick questions before we jump into a lengthier discussion.

1) You are discussing perldl.conf, the file for the build process, correct?

Yes.

2) Do you want said docs to be CPAN legible?

Would be nice but could be addressed separately.

3) Do you want PDL::Config to have machine-specific docs generated along
with this process?

Yes.

4) Do you want CPAN-legible docs for PDL::Config while we're at it? Like
stubs?

Yes.  The goal is that ?PDL::Config would document
the PDL configuration and the specific features
enabled/disabled for a given installation.

--Chris

David
On Nov 11, 2011 3:57 PM, "chm"<[email protected]>  wrote:

I would like to add some documentation for the
PDL config information in the perldl.conf file
and am looking for ideas on a clean way to implement
this.  The requirements for the approach:

- easy to modify/create/verify by hand
- robust against typos, self-checking or reporting errors
- beginner-proof
- keeps values near their documentation

A simple stick POD in place of the commented
description lines doesn't work because the hash
is assigned in a single statement and perl
doesn't like =pod directives to mingle there.

One possibility would be to have all of the
configure file be POD and then generate the
hash data by processing that instead.  It would
definitely solve the POD problem but I'm not
sure the best way to keep things from being
too fragile.

Thoughts and ideas welcome!

Thanks,
Chris

______________________________**_________________
Perldl mailing list
[email protected]
http://mailman.jach.hawaii.**edu/mailman/listinfo/perldl<http://mailman.jach.hawaii.edu/mailman/listinfo/perldl>




_______________________________________________
Perldl mailing list
[email protected]
http://mailman.jach.hawaii.edu/mailman/listinfo/perldl

Reply via email to