Questions about Perl and doc

Russ Allbery rra at stanford.edu
Wed Sep 5 19:19:35 UTC 2007


Julien ÉLIE <julien at trigofacile.com> writes:
> En réponse à Russ Allbery :

>> This would go away if we replaced innshellvars.pl with a real Perl
>> module that declares and exports its variables properly, something I
>> was hoping to do eventually.

> That is to say innshellvars.pm which defines 'package inn' and only
> exports variables with EXPORT_OK (so as not to pollute the namespace)?

> And then fixscript would put:
>     use lib '@libdir@';
>     use innshellvars;

It should really be called something like INN::Config, but yes, that's the
basic idea.

>> Yeah, that's probably not a bad idea.  I just wasn't thinking about
>> that when I wrote it.

> It would need a little rewrite to split filter_innd and filter_nnrpd.
> And maybe also nnrpd_access and nnrpd_auth.  Besides, it would make it
> simpler since there are similar behaviours regarding Perl and Python
> implementations.  A possibility would be a general introduction for each
> file, then a part for what is specific to Perl (with examples) and
> another part for Python (with examples).

Yeah, that's a good idea, I think.

>> Likewise, it probably wouldn't be a bad idea to install the INSTALL
>> document as an inn man page in some section.

> Which name (and number) for the man page?
> What for the checklist?

I'd be tempted to do something like inn(7) for the install guide, since
it's also a general introduction to INN, although the section numbers
other than 1, 2, 3, 5, and 8 vary a lot between systems and on some
systems that's going to look like a very odd section for it.

The checklist seems to be of more marginal utility after installation to
me.

-- 
Russ Allbery (rra at stanford.edu)             <http://www.eyrie.org/~eagle/>

    Please send questions to the list rather than mailing me directly.
     <http://www.eyrie.org/~eagle/faqs/questions.html> explains why.


More information about the inn-workers mailing list