Front page | perl.perl5.porters |
Postings from February 2009
[PATCH] Markup in the NAME section is not portable
Thread Next
From:
Niko Tyni
Date:
February 16, 2009 00:26
Subject:
[PATCH] Markup in the NAME section is not portable
Message ID:
1234729010-22251-1-git-send-email-ntyni@debian.org
As discussed in [rt.cpan.org #43078] and Debian bug #304143,
markup in the NAME section of manual pages is not portable.
In particular, the whatis parser on Debian cannot handle C<> in whatis
entries, resulting in garbage like
c2ph (1) - Dump C structures as generated from *(C`cc - g - S*(C' stabs
My tests indicate Solaris 10 and Tru64 5.1 are affected too.
http://rt.cpan.org/Public/Bug/Display.html?id=43078
http://bugs.debian.org/304143
---
ext/Data-Dumper/Dumper.pm | 2 +-
lib/Term/ReadLine.pm | 2 +-
lib/charnames.pm | 2 +-
lib/if.pm | 2 +-
pod/perlpacktut.pod | 2 +-
utils/c2ph.PL | 2 +-
6 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/ext/Data-Dumper/Dumper.pm b/ext/Data-Dumper/Dumper.pm
index b716ff2..fbcb09f 100644
--- a/ext/Data-Dumper/Dumper.pm
+++ b/ext/Data-Dumper/Dumper.pm
@@ -725,7 +725,7 @@ __END__
=head1 NAME
-Data::Dumper - stringified perl data structures, suitable for both printing and C<eval>
+Data::Dumper - stringified perl data structures, suitable for both printing and "eval"
=head1 SYNOPSIS
diff --git a/lib/Term/ReadLine.pm b/lib/Term/ReadLine.pm
index d251271..5fee3c4 100644
--- a/lib/Term/ReadLine.pm
+++ b/lib/Term/ReadLine.pm
@@ -1,6 +1,6 @@
=head1 NAME
-Term::ReadLine - Perl interface to various C<readline> packages.
+Term::ReadLine - Perl interface to various "readline" packages.
If no real package is found, substitutes stubs instead of basic functions.
=head1 SYNOPSIS
diff --git a/lib/charnames.pm b/lib/charnames.pm
index b8eb2b4..438d7ca 100644
--- a/lib/charnames.pm
+++ b/lib/charnames.pm
@@ -324,7 +324,7 @@ __END__
=head1 NAME
-charnames - define character names for C<\N{named}> string literal escapes
+charnames - define character names for "\N{named}" string literal escapes
=head1 SYNOPSIS
diff --git a/lib/if.pm b/lib/if.pm
index 5f6bcc8..32b77a0 100644
--- a/lib/if.pm
+++ b/lib/if.pm
@@ -23,7 +23,7 @@ __END__
=head1 NAME
-if - C<use> a Perl module if a condition holds
+if - "use" a Perl module if a condition holds
=head1 SYNOPSIS
diff --git a/pod/perlpacktut.pod b/pod/perlpacktut.pod
index 73b2f43..0251ce7 100644
--- a/pod/perlpacktut.pod
+++ b/pod/perlpacktut.pod
@@ -1,6 +1,6 @@
=head1 NAME
-perlpacktut - tutorial on C<pack> and C<unpack>
+perlpacktut - tutorial on the pack and unpack functions
=head1 DESCRIPTION
diff --git a/utils/c2ph.PL b/utils/c2ph.PL
index 39545e3..b26d6b4 100644
--- a/utils/c2ph.PL
+++ b/utils/c2ph.PL
@@ -69,7 +69,7 @@ print OUT <<'!NO!SUBS!';
=head1 NAME
-c2ph, pstruct - Dump C structures as generated from C<cc -g -S> stabs
+c2ph, pstruct - Dump C structures as generated from "cc -g -S" stabs
=head1 SYNOPSIS
--
1.5.6.5
Thread Next
-
[PATCH] Markup in the NAME section is not portable
by Niko Tyni