LMPX.COM |
Home | Linux | Mysql | PHP | XML | ||
|
|
|||
From: esr@thyrsus.com Date: Mon Jan 1 17:06:06 2007 Subject: problems in several man pages you maintain
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 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 2005-02-02 02:20:20.334547656 -0500
+++ Carp.3pm 2005-02-02 02:21:57.984702576 -0500
@@ -131,18 +131,8 @@
.IX Title "Carp 3pm"
.TH Carp 3pm "2001-09-21" "perl v5.8.6" "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, confess, shortmess, longmess \-
+warning- and error-message functions for Perl modules
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
-----------------------------
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 Xman, Rosetta, 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 2006-12-20 01:10:07.000000000 -0500
+++ ModPerl::Code.3pm 2006-12-20 01:10:34.000000000 -0500
@@ -128,147 +128,6 @@
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
-.IX Title "ModPerl::Code 3"
-.TH ModPerl::Code 3 "2005-10-20" "perl v5.8.8" "User Contributed Perl Documentation"
-.SH "SYNOPSIS"
-.IX Header "SYNOPSIS"
-.SH "CONSTANTS"
-.IX Header "CONSTANTS"
-\&\s-1EOF\s0
-.PP
-.Vb 3
-\& my $groups = $data{$class};
-\& for my $group (sort keys %$groups) {
-\& print $fh <<"EOF";
-.Ve
-.ie n .Sh """:$group"""
-.el .Sh "\f(CW:$group\fP"
-.IX Subsection ":$group"
-.Vb 1
-\& use $class\e::Const -compile qw(:$group);
-.Ve
-.PP
-The \f(CW\*(C`:$group\*(C'\fR group is for \s-1XXX\s0 constants.
-.PP
-\&\s-1EOF\s0
-.PP
-.Vb 4
-\& for my $const (sort @{ $groups->{$group} }) {
-\& print $fh "=head3 C<$class\e::$const>\en\en\en";
-\& }
-\& }
-.Ve
-.PP
-.Vb 3
-\& print $fh "=cut\en";
-\& }
-\&}
-.Ve
-.PP
-sub generate_constants_lookup_doc {
- my ($data) = \f(CW@_\fR;
-.PP
-.Vb 2
-\& while (my ($class, $groups) = each %$Apache2::ConstantsTable) {
-\& my $constants = [map { @$_ } values %$groups];
-.Ve
-.PP
-.Vb 3
-\& constants_lookup_code_doc($constants, $class, $data);
-\& }
-\&}
-.Ve
-.PP
-sub generate_constants_group_lookup_doc {
- my ($data) = \f(CW@_\fR;
-.PP
-.Vb 4
-\& while (my ($class, $groups) = each %$Apache2::ConstantsTable) {
-\& constants_group_lookup_code_doc($class, $groups, $data);
-\& }
-\&}
-.Ve
-.PP
-sub constants_group_lookup_code_doc {
- my ($class, \f(CW$groups\fR, \f(CW$data\fR) = \f(CW@_\fR;
- my \f(CW@tags\fR;
- my \f(CW@code\fR;
-.PP
-.Vb 11
-\& while (my ($group, $constants) = each %$groups) {
-\& $data->{$class}{$group} = [
-\& map {
-\& my @ifdef = constants_ifdef($_);
-\& s/^($constant_prefixes)_?//o;
-\& $seen_const{$class}{$_}++;
-\& $_;
-\& } @$constants
-\& ];
-\& }
-\&}
-.Ve
-.PP
-sub constants_lookup_code_doc {
- my ($constants, \f(CW$class\fR, \f(CW$data\fR) = \f(CW@_\fR;
-.PP
-.Vb 1
-\& my (%switch, %alias);
-.Ve
-.PP
-.Vb 1
-\& %alias = %shortcuts;
-.Ve
-.PP
-.Vb 3
-\& my $postfix = lc $class;
-\& my $package = $class . '::';
-\& my $package_len = length $package;
-.Ve
-.PP
-.Vb 1
-\& my $func = canon_func(qw(constants lookup), $postfix);
-.Ve
-.PP
-.Vb 10
-\& for (@$constants) {
-\& if (s/^($constant_prefixes)(_)?//o) {
-\& $alias{$_} = join $2 || "", $1, $_;
-\& }
-\& else {
-\& $alias{$_} ||= $_;
-\& }
-\& next unless /^([A-Z])/;
-\& push @{ $switch{$1} }, $_;
-\& }
-.Ve
-.PP
-.Vb 9
-\& for my $key (sort keys %switch) {
-\& my $names = $switch{$key};
-\& for my $name (@$names) {
-\& my @ifdef = constants_ifdef($alias{$name});
-\& push @{ $data->{$class}{other} }, $name
-\& unless $seen_const{$class}{$name}
-\& }
-\& }
-\&}
-.Ve
-.PP
-sub generate_exports {
- my ($self, \f(CW$c_fh\fR) = \f(CW@_\fR;
- require ModPerl::WrapXS;
- ModPerl::WrapXS\->generate_exports($c_fh);
-}
-.PP
-# src/modules/perl/*.c files needed to build APR/APR::* outside
-# of mod_perl.so
-sub src_apr_ext {
- 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"
-----------------------------
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 perlop.1:
1. Ambiguous or invalid backslash. This doesn't cause groff a problem.
but it confuses doclifter and may confuse older troff implementations.
--- perlop.1-orig 2006-12-27 14:41:06.000000000 -0500
+++ perlop.1 2006-12-27 14:41:59.000000000 -0500
@@ -1109,7 +1109,7 @@
.PP
The following escape sequences are available in constructs that interpolate
and in transliterations.
-.IX Xref "\t \n \r \f \b \a \e \x \0 \c \N"
+.IX Xref "\et \en \er \ef \eb \ea \ee \ex \e0 \ec \eN"
.PP
.Vb 12
\& \et tab (HT, TAB)
@@ -1131,7 +1131,7 @@
.PP
The following escape sequences are available in constructs that interpolate
but not in transliterations.
-.IX Xref "\l \u \L \U \E \Q"
+.IX Xref "\el \eu \eL \eU \eE \eQ"
.PP
.Vb 6
\& \el lowercase next char
@@ -1162,7 +1162,7 @@
and although they often accept just \f(CW"\e012"\fR, they seldom tolerate just
\&\f(CW"\e015"\fR. If you get in the habit of using \f(CW"\en"\fR for networking,
you may be burned some day.
-.IX Xref "newline line terminator eol end of line \n \r \r\n"
+.IX Xref "newline line terminator eol end of line \en \er \er\en"
.PP
For constructs that do interpolate, variables beginning with "\f(CW\*(C`$\*(C'\fR\*(L"
or \*(R"\f(CW\*(C`@\*(C'\fR" are interpolated. Subscripted variables such as \f(CW$a[3]\fR or
-----------------------------
Problems with perlre.1:
1. Ambiguous or invalid backslash. This doesn't cause groff a problem.
but it confuses doclifter and may confuse older troff implementations.
--- perlre.1-orig 2006-12-27 14:45:52.000000000 -0500
+++ perlre.1 2006-12-27 14:46:20.000000000 -0500
@@ -284,7 +284,7 @@
.PP
Because patterns are processed as double quoted strings, the following
also work:
-.IX Xref "\t \n \r \f \a \l \u \L \U \E \Q \0 \c \N \x"
+.IX Xref "\et \en \er \ef \ea \el \eu \eL \eU \eE \eQ \e0 \ec \eN \ex"
.PP
.Vb 17
\& \et tab (HT, TAB)
@@ -316,7 +316,7 @@
You'll need to write something like \f(CW\*(C`m/\eQuser\eE\e@\eQhost/\*(C'\fR.
.PP
In addition, Perl defines the following:
-.IX Xref "metacharacter \w \W \s \S \d \D \X \p \P \C word whitespace"
+.IX Xref "metacharacter \ew \eW \es \eS \ed \eD \eX \ep \eP \eC word whitespace"
.PP
.Vb 14
\& \ew Match a "word" character (alphanumeric plus "_")
-----------------------------
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
| Navigate in group perl.documentation at sever nntp.perl.org | |
| Previous | Next |
| © No Copyright You are free to use Anything |
Site Maintained by PHP Developer
Powered By PHP Consultants |