INN commit: trunk/doc/pod (5 files)
Russ_Allbery at isc.org
Mon Apr 28 08:42:23 UTC 2008
Date: Monday, April 28, 2008 @ 01:42:23
Better PODification of the names of Perl modules.
hacking.pod | 4 ++--
hook-perl.pod | 6 +++---
install.pod | 4 ++--
newslog.pod | 2 +-
simpleftp.pod | 2 +-
5 files changed, 9 insertions(+), 9 deletions(-)
--- hacking.pod 2008-04-26 11:32:18 UTC (rev 7801)
+++ hacking.pod 2008-04-28 08:42:23 UTC (rev 7802)
@@ -112,7 +112,7 @@
F<modules/by-module/Pod>. You'll need PodParser (for versions of Perl
before 5.6.1; 5.6.1 and later come with a recent enough version) and the
latest version of podlators. For versions of Perl earlier than 5.005,
-you'll also need File::Spec in F<modules/by-module/File>.
+you'll also need C<File::Spec> in F<modules/by-module/File>.
S<podlators 1.25> or later will build INN's documentation without significant
changes from the versions that are checked into the repository.
@@ -306,7 +306,7 @@
substitute values in them. Any values needed at run-time should instead
be available from all of the different innshellvars.
-As for Perl, the INN::Config module has the same features as
+As for Perl, the C<INN::Config> module has the same features as
F<innshellvars.pl> (only kept for compatibility reasons with old scripts
not shipped with INN); however, it can be safely used with warnings on
in Perl scripts.
--- hook-perl.pod 2008-04-26 11:32:18 UTC (rev 7801)
+++ hook-perl.pod 2008-04-28 08:42:23 UTC (rev 7802)
@@ -261,7 +261,7 @@
=item INN::syslog(level, message)
Logs a message via syslog(3). This is quite a bit more reliable and
-portable than trying to use Sys::Syslog from inside the Perl filter. Only
+portable than trying to use C<Sys::Syslog> from inside the Perl filter. Only
the first character of the level argument matters; the valid letters are
the first letters of ALERT, CRIT, ERR, WARNING, NOTICE, INFO, and DEBUG
(case-insensitive) and specify the priority at which the message is
@@ -532,7 +532,7 @@
Calling exit directly, however, *will* kill the innd or nnrpd process, so
don't do that. Similarly, you probably don't want to call fork (or any
-other function that results in a fork such as system, IPC::Open3::open3(),
+other function that results in a fork such as system, C<IPC::Open3::open3()>,
or any use of backticks) since there are possibly unflushed buffers that
could get flushed twice, lots of open state that may not get closed
properly, and innumerable other potential problems. In general, be aware
@@ -541,7 +541,7 @@
You can use print and warn inside Perl code to send output to STDOUT or
STDERR, but you probably shouldn't. Instead, open a log file and print to
-it instead (or, in the innd filter, use INN::syslog() to write messages
+it instead (or, in the innd filter, use C<INN::syslog()> to write messages
via syslog like the rest of INN). If you write to STDOUT or STDERR, where
that data will go depends on where the filter is running; inside innd, it
will go to the news log or the errlog, and inside nnrpd it will probably
--- install.pod 2008-04-26 11:32:18 UTC (rev 7801)
+++ install.pod 2008-04-28 08:42:23 UTC (rev 7802)
@@ -95,7 +95,7 @@
If you're using a version of Perl prior to 5.6.0, you may need to make
sure that the Perl versions of your system header files have been
-generated in order for Sys::Syslog to work properly (used by various
+generated in order for C<Sys::Syslog> to work properly (used by various
utility programs, including B<controlchan>). To do this, run the following
@@ -103,7 +103,7 @@
# h2ph * sys/*
An even better approach is to install S<Perl 5.6.1> or later, which have a
-fixed version of Sys::Syslog that doesn't require this (as well as many
+fixed version of C<Sys::Syslog> that doesn't require this (as well as many
other improvements over earlier versions of Perl).
--- newslog.pod 2008-04-26 11:32:18 UTC (rev 7801)
+++ newslog.pod 2008-04-28 08:42:23 UTC (rev 7802)
@@ -195,7 +195,7 @@
The B<perl-nocem> program appends all status messages to this file if
-Sys::Syslog is not used (otherwise, such messages are appended to
+C<Sys::Syslog> is not used (otherwise, such messages are appended to
F<news.notice>). It is rotated by B<scanlogs>.
--- simpleftp.pod 2008-04-26 11:32:18 UTC (rev 7801)
+++ simpleftp.pod 2008-04-28 08:42:23 UTC (rev 7802)
@@ -35,7 +35,7 @@
Tossed off by David C Lawrence <tale at isc.org> for InterNetNews.
-Rewritten to use Net::FTP by Julien Elie <julien at trigofacile.com>.
+Rewritten to use C<Net::FTP> by Julien Elie <julien at trigofacile.com>.
More information about the inn-committers