develooper Front page | perl.perl5.porters | Postings from February 2013

Re: [perl #116963] Add documentation on the advantages of perldoc forman users to perl.pod

Thread Previous | Thread Next
From:
Reuben Thomas
Date:
February 27, 2013 15:19
Subject:
Re: [perl #116963] Add documentation on the advantages of perldoc forman users to perl.pod
Message ID:
CAOnWdogQyv0SzCun9L6mPij5AksQOfOVHiYogx=0yL7qpa-2uA@mail.gmail.com
On 27 February 2013 15:11, Reuben Thomas <rrt@sc3d.org> wrote:
> On 27 February 2013 14:43, H. Merijn Brand via RT
> <perlbug-followup@perl.org> wrote:
> .
>>
>> You could refer to its own docs, somewhat like
>> --8<---
>> Some documentation is not available as man pages, so if a
>> cross-reference is not found by man, try it with L<perldoc>.  Perldoc can
>> also take you directly to documentation for functions (with the B<-f>
>> switch). See C<perldoc --help> (or C<perldoc perldoc> or C<man perldoc>
>> for other helpful options L<perldoc> has to offer.
>> -->8---
>
> That sounds like a low-risk option.
>
>> FWIW I think I like the intent of the patch
>
> Thanks. Would someone with the commit bit like to speak up?

Oops, a little bird tells me you're a committer. In that case, here's
the patch re-revised as per your suggestion:

diff --git a/pod/perl.pod b/pod/perl.pod
index d3f9c05..5e7686a 100644
--- a/pod/perl.pod
+++ b/pod/perl.pod
@@ -280,6 +280,12 @@ aux a2p c2ph h2ph h2xs perlbug pl2pm pod2html
pod2man s2p splain xsubpp
 On a Unix-like system, these documentation files will usually also be
 available as manpages for use with the F<man> program.

+Some documentation is not available as man pages, so if a
+cross-reference is not found by man, try it with L<perldoc>.  Perldoc can
+also take you directly to documentation for functions (with the B<-f>
+switch). See C<perldoc --help> (or C<perldoc perldoc> or C<man perldoc>
+for other helpful options L<perldoc> has to offer.
+
 In general, if something strange has gone wrong with your program and you're
 not sure where you should look for help, try making your code comply with
 B<use strict> and B<use warnings>.  These will often point out exactly
--
1.7.10.4


--
http://rrt.sc3d.org

Thread Previous | Thread Next


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About