problems in several man pages you maintain
[email protected] Fri, 14 Jan 2005 03:27:11 -0500
| Newsgroups | perl.documentation |
|---|---|
| Message-ID | <[email protected]> |
This is automatically generated email about problems in a man page for which
you appear to be responsible. If you are not the right person or list, tell
me and I will attempt to correct my database.
See http://catb.org/~esr/doclifter/problems.html for details on how and
why these patches were generated. Feel free to email me with any questions.
Note: These patches do not change the mod date of any manual page. You
may wish to do that by hand.
Problems with AnyDBM_File.3pm:
(May reflect bugs in POD).
1. There are multiple description lines. This makes it impossible to
translate the page to DocBook. It may also confuse some
implementations of man -k.
--- AnyDBM_File.3pm-orig 2004-11-17 23:10:32.174714560 -0500
+++ AnyDBM_File.3pm 2004-11-17 23:11:46.801369584 -0500
@@ -131,9 +131,7 @@
.IX Title "AnyDBM_File 3pm"
.TH AnyDBM_File 3pm "2001-09-21" "perl v5.8.5" "Perl Programmers Reference Guide"
.SH "NAME"
-AnyDBM_File \- provide framework for multiple DBMs
-.PP
-NDBM_File, DB_File, GDBM_File, SDBM_File, ODBM_File \- various DBM implementations
+AnyDBM_File, NDBM_File, DB_File, GDBM_File, SDBM_File, ODBM_File \- framework for multiple DBMs, and the implementations thereof
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
-----------------------------
Problems with Apache::TestConfig.3pm:
(May reflect bugs in POD).
1. There are multiple description lines. This makes it impossible to
translate the page to DocBook. It may also confuse some
implementations of man -k.
--- Apache::TestConfig.3pm-orig 2004-11-19 06:09:08.950587752 -0500
+++ Apache::TestConfig.3pm 2004-11-19 06:10:20.157762616 -0500
@@ -131,9 +131,7 @@
.IX Title "Apache::TestConfig 3"
.TH Apache::TestConfig 3 "2004-08-06" "perl v5.8.5" "User Contributed Perl Documentation"
.SH "NAME"
-Apache::TestConfigData \- Configuration file for Apache::Test
-.SH "NAME"
-Apache::TestConfig \-\- Test Configuration setup module
+Apache::TestConfig, Apache::TestConfigData \- Test Configuration setup module snd configuration file
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
-----------------------------
Problems with B::Stash.3pm:
(May reflect bugs in POD).
1. Page is empty. This probably means there is some sort of glitch in
your build machinery.
(No patch.)
-----------------------------
Problems with Carp::Heavy.3pm:
(May reflect bugs in POD).
1. Page is empty. This probably means there is some sort of glitch in
your build machinery.
(No patch.)
-----------------------------
Problems with Encode::CJKConstants.3pm:
(May reflect bugs in POD).
1. Page is empty. This probably means there is some sort of glitch in
your build machinery.
(No patch.)
-----------------------------
Problems with Encode::CN::HZ.3pm:
(May reflect bugs in POD).
1. Page is empty. This probably means there is some sort of glitch in
your build machinery.
(No patch.)
-----------------------------
Problems with Encode::Config.3pm:
(May reflect bugs in POD).
1. Page is empty. This probably means there is some sort of glitch in
your build machinery.
(No patch.)
-----------------------------
Problems with Encode::JP::H2Z.3pm:
(May reflect bugs in POD).
1. Page is empty. This probably means there is some sort of glitch in
your build machinery.
(No patch.)
-----------------------------
Problems with Encode::JP::JIS7.3pm:
(May reflect bugs in POD).
1. Page is empty. This probably means there is some sort of glitch in
your build machinery.
(No patch.)
-----------------------------
Problems with KR::2022_KR.3pm:
(May reflect bugs in POD).
1. Page is empty. This probably means there is some sort of glitch in
your build machinery.
(No patch.)
-----------------------------
Problems with Mail::SpamAssassin::Plugin::Hashcash.3pm:
(May reflect bugs in POD).
1. Page is empty. This probably means there is some sort of glitch in
your build machinery.
(No patch.)
-----------------------------
Problems with Mail::SpamAssassin::Plugin::SPF.3pm:
(May reflect bugs in POD).
1. Page is empty. This probably means there is some sort of glitch in
your build machinery.
(No patch.)
-----------------------------
Problems with Mail::SpamAssassin::PluginHandler.3pm:
(May reflect bugs in POD).
1. Page is empty. This probably means there is some sort of glitch in
your build machinery.
(No patch.)
-----------------------------
Problems with NetSNMP::netsnmp_request_infoPtr.3pm:
(May reflect bugs in POD).
1. Page is empty. This probably means there is some sort of glitch in
your build machinery.
(No patch.)
-----------------------------
Problems with SVN::Fs.3pm:
(May reflect bugs in POD).
1. Page is empty. This probably means there is some sort of glitch in
your build machinery.
(No patch.)
-----------------------------
Problems with Carp.3pm:
(May reflect bugs in POD).
1. There are multiple description lines. This makes it impossible to
translate the page to DocBook. It may also confuse some
implementations of man -k.
--- Carp.3pm-orig 2003-12-15 09:23:36.000000000 -0500
+++ Carp.3pm 2003-12-15 09:25:06.000000000 -0500
@@ -131,18 +131,7 @@
.IX Title "Carp 3pm"
.TH Carp 3pm "2002-06-01" "perl v5.8.0" "Perl Programmers Reference Guide"
.SH "NAME"
-carp \- warn of errors (from perspective of caller)
-.PP
-cluck \- warn of errors with stack backtrace
- (not exported by default)
-.PP
-croak \- die of errors (from perspective of caller)
-.PP
-confess \- die of errors with stack backtrace
-.PP
-shortmess \- return the message that carp and croak produce
-.PP
-longmess \- return the message that cluck and confess produce
+carp, cluck, croak, shortmess, longmess \- error-warning and exit facilities
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
-----------------------------
Problems with File::Basename.3pm:
(May reflect bugs in POD).
1. There are multiple description lines. This makes it impossible to
translate the page to DocBook. It may also confuse some
implementations of man -k.
--- File::Basename.3pm-orig 2003-12-15 09:45:12.000000000 -0500
+++ File::Basename.3pm 2003-12-15 09:46:35.000000000 -0500
@@ -131,11 +131,7 @@
.IX Title "File::Basename 3pm"
.TH File::Basename 3pm "2002-06-01" "perl v5.8.0" "Perl Programmers Reference Guide"
.SH "NAME"
-fileparse \- split a pathname into pieces
-.PP
-basename \- extract just the filename from a path
-.PP
-dirname \- extract just the directory from a path
+fileparse, basename, dirname \- extract segments, basename, or directory name from a filename
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
-----------------------------
Problems with Mail::SpamAssassin::Plugin.3pm:
(May reflect bugs in POD).
1. List syntax error. This means .IP, .TP or .RS/.RE markup is garbled.
This confuses doclifter, and may also mess up stricter troff
interpreters like groffer and TkMan.
(No patch.)
-----------------------------
Problems with ModPerl::Code.3pm:
(May reflect bugs in POD).
1. Section or macro out of place; this confuses translators.
--- ModPerl::Code.3pm-orig 2005-01-13 03:37:42.000000000 -0500
+++ ModPerl::Code.3pm 2005-01-13 03:39:23.000000000 -0500
@@ -130,8 +130,15 @@
.\"
.IX Title "ModPerl::Code 3"
.TH ModPerl::Code 3 "2004-08-23" "perl v5.8.5" "User Contributed Perl Documentation"
+.SH "NAME"
+ModPerl::Code \- Generate mod_perl glue code
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
+.Vb 3
+\& use ModPerl::Code ();
+\& my $code = ModPerl::Code->new;
+\& $code->generate;
+.Ve
.SH "CONSTANTS"
.IX Header "CONSTANTS"
\&\s-1EOF\s0
@@ -266,18 +273,6 @@
return map { \*(L"modperl_$_\*(R" } (qw(error bucket),
map { \*(L"common_$_\*(R" } qw(util log));
}
-.PP
-1;
-_\|_END_\|_
-.SH "NAME"
-ModPerl::Code \- Generate mod_perl glue code
-.SH "SYNOPSIS"
-.IX Header "SYNOPSIS"
-.Vb 3
-\& use ModPerl::Code ();
-\& my $code = ModPerl::Code->new;
-\& $code->generate;
-.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides functionality for generating mod_perl glue code.
-----------------------------
Problems with pcrepattern.3:
1. Ambiguous or invalid backslash. This doesn't cause groff a problem.
but it confuses doclifter and may confuse older troff implementations.
--- pcrepattern.3-orig 2005-01-13 12:16:47.000000000 -0500
+++ pcrepattern.3 2005-01-13 12:17:12.000000000 -0500
@@ -1433,7 +1433,7 @@
can put a number less than 256 after the letter C. The default value is zero.
For example, this pattern has two callout points:
.sp
- (?C1)\dabc(?C2)def
+ (?C1)\edabc(?C2)def
.sp
If the PCRE_AUTO_CALLOUT flag is passed to \fBpcre_compile()\fP, callouts are
automatically installed before each item in the pattern. They are all numbered
-----------------------------
Problems with pcrecallout.3:
1. Ambiguous or invalid backslash. This doesn't cause groff a problem.
but it confuses doclifter and may confuse older troff implementations.
--- pcrecallout.3-orig 2005-01-13 12:14:06.000000000 -0500
+++ pcrecallout.3 2005-01-13 12:15:28.000000000 -0500
@@ -17,7 +17,7 @@
a number less than 256 after the letter C. The default value is zero.
For example, this pattern has two callout points:
.sp
- (?C1)\deabc(?C2)def
+ (?C1)\edeabc(?C2)def
.sp
If the PCRE_AUTO_CALLOUT option bit is set when \fBpcre_compile()\fP is called,
PCRE automatically inserts callouts, all with number 255, before each item in
-----------------------------
Problems with PDL::BAD2_demo.3pm:
(May reflect bugs in POD).
1. Page is empty. This probably means there is some sort of glitch in
your build machinery.
(No patch.)
-----------------------------
Problems with PDL::BAD_demo.3pm:
(May reflect bugs in POD).
1. Page is empty. This probably means there is some sort of glitch in
your build machinery.
(No patch.)
-----------------------------
Problems with PDL::Config.3pm:
(May reflect bugs in POD).
1. Page is empty. This probably means there is some sort of glitch in
your build machinery.
(No patch.)
-----------------------------
Problems with PDL::Doc::Config:
1. Page is empty. This probably means there is some sort of glitch in
your build machinery.
(No patch.)
-----------------------------
Problems with XML::DOM::Element.3pm:
(May reflect bugs in POD).
1. pod2man generates an unbalanced .RS tag. This is a bug.
--- XML::DOM::Element.3pm-orig 2004-07-26 11:40:06.063084928 -0400
+++ XML::DOM::Element.3pm 2004-07-26 11:40:22.241625416 -0400
@@ -272,7 +272,6 @@
.IX Item "NOT_FOUND_ERR"
Raised if oldAttr is not an attribute of the element.
.RE
-.RS 4
.Sh "Additional methods not in the \s-1DOM\s0 Spec"
.IX Subsection "Additional methods not in the DOM Spec"
.IP "setTagName (newTagName)" 4
-----------------------------
--
Eric S. Raymond