headers
esr | 2 Jan 2007 01:04
Picon
Gravatar

problems in XML::Parser::Style::Objects.3pm, XML::Parser::Style::Tree.3pm, XML::Parser::Style::Subs.3pm

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 XML::Parser::Style::Objects.3pm:
(May reflect bugs in POD).

1. Missing or garbled name section.  The most common form of garbling
is a missing - or extra -. Or your manual page may have been generated
by a tool that doesn't emit a NAME section as it should.  These
problems make it impossible to lift the page to DocBook.  They
can also confuse some implementations of man -k.

--- XML::Parser::Style::Objects.3pm-orig	2004-07-21 20:51:43.797861432 -0400
+++ XML::Parser::Style::Objects.3pm	2004-07-21 20:52:50.149774408 -0400
 <at>  <at>  -131,7 +131,7  <at>  <at> 
 .IX Title "Parser::Style::Objects 3"
 .TH Parser::Style::Objects 3 "2003-08-18" "perl v5.8.3" "User Contributed Perl Documentation"
 .SH "NAME"
-XML::Parser::Style::Objects
+XML::Parser::Style::Objects \- XML parser returning objects
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
 .Vb 3
-----------------------------
(Continue reading)

Permalink | Reply | 0 comments |
headers
esr | 2 Jan 2007 01:06
Picon
Gravatar

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
 <at>  <at>  -131,9 +131,7  <at>  <at> 
 .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
(Continue reading)

Permalink | Reply | 2 comments |
headers
Sébastien Aperghis-Tramoni | 2 Jan 2007 01:25
Picon
Favicon

Re: problems in several man pages you maintain

esr <at> thyrsus.com wrote:

> 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.

Hello,

Perl documentation is maintained using the POD format. Unix manual  
pages in nroff format are generated from the POD. Therefore patches  
to the resulting nroff are not very useful. Plus, if what you want is  
to convert the documentation to DocBook, it's better to use a program  
or module which uses the POD as the source, not the nroff. Something  
like Pod::DocBook or using Pod::Simple::XMLOutStream and a small XSLT  
to transform the XML stream to DocBook for example.

   » http://search.cpan.org/dist/Pod-DocBook/
   » http://search.cpan.org/dist/Pod-Simple/

--

--
(Continue reading)

Permalink | Reply | 1 comment |
headers
Eric S. Raymond | 2 Jan 2007 01:35
Picon
Gravatar

Re: problems in several man pages you maintain

Sébastien Aperghis-Tramoni <maddingue <at> free.fr>:
> Perl documentation is maintained using the POD format. Unix manual  
> pages in nroff format are generated from the POD. Therefore patches  
> to the resulting nroff are not very useful. Plus, if what you want is  
> to convert the documentation to DocBook, it's better to use a program  
> or module which uses the POD as the source, not the nroff. Something  
> like Pod::DocBook or using Pod::Simple::XMLOutStream and a small XSLT  
> to transform the XML stream to DocBook for example.
> 
>   » http://search.cpan.org/dist/Pod-DocBook/
>   » http://search.cpan.org/dist/Pod-Simple/

I'm aware of this background. Sometimes, though, errors in generated
pages are traceable to POD errors that should be fixed at that level.
--

-- 
		<a href="http://www.catb.org/~esr/">Eric S. Raymond</a>
Permalink | Reply | 0 comments |
headers
esr | 4 Jan 2007 20:41
Picon
Gravatar

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 DBM_Filter::compress.3pm:
(May reflect bugs in POD).

1. Missing or garbled name section.  The most common form of garbling
is a missing - or extra -. Or your manual page may have been generated
by a tool that doesn't emit a NAME section as it should.  Or your page
may add running text duch as a version or authorship banner.  These
problems make it impossible to lift the page to DocBook.  They
can also confuse third-party manpage browsers and some implementations
of man -k.

--- DBM_Filter::compress.3pm-orig	2007-01-03 19:27:12.000000000 -0500
+++ DBM_Filter::compress.3pm	2007-01-03 19:28:06.000000000 -0500
 <at>  <at>  -130,8 +130,9  <at>  <at> 
 .\"
 .IX Title "DBM_Filter::compress 3pm"
 .TH DBM_Filter::compress 3pm "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide"
-.SH "DBM_Filter::compress"
+.SH NAME
 .IX Header "DBM_Filter::compress"
+DBM_Filter::compress \- set compression on a DBM database
(Continue reading)

Permalink | Reply | 0 comments |

Gmane