Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix readline docs in perlfunc #16874

Closed
p5pRT opened this issue Mar 6, 2019 · 5 comments
Closed

fix readline docs in perlfunc #16874

p5pRT opened this issue Mar 6, 2019 · 5 comments

Comments

@p5pRT
Copy link

p5pRT commented Mar 6, 2019

Migrated from rt.perl.org#133901 (status was 'open')

Searchable as RT133901$

@p5pRT
Copy link
Author

p5pRT commented Mar 6, 2019

From m@japh.se

Created by m@japh.se

The wording was a bit off in the readline docs in perlfunc.

Perl Info

Flags:
    category=docs
    severity=low
    Type=Patch
    PatchStatus=HasPatch

Site configuration information for perl 5.28.1:

Configured by builduser at Fri Nov 30 14:14:28 CET 2018.

Summary of my perl5 (revision 5 version 28 subversion 1) configuration:
   
  Platform:
    osname=linux
    osvers=4.19.1-arch1-1-arch
    archname=x86_64-linux-thread-multi
    uname='linux flo-64 4.19.1-arch1-1-arch #1 smp preempt sun nov 4 16:49:26 utc 2018 x86_64 gnulinux '
    config_args='-des -Dusethreads -Duseshrplib -Doptimize=-march=x86-64 -mtune=generic -O2 -pipe -fstack-protector-strong -fno-plt -Dprefix=/usr -Dvendorprefix=/usr -Dprivlib=/usr/share/perl5/core_perl -Darchlib=/usr/lib/perl5/5.28/core_perl -Dsitelib=/usr/share/perl5/site_perl -Dsitearch=/usr/lib/perl5/5.28/site_perl -Dvendorlib=/usr/share/perl5/vendor_perl -Dvendorarch=/usr/lib/perl5/5.28/vendor_perl -Dscriptdir=/usr/bin/core_perl -Dsitescript=/usr/bin/site_perl -Dvendorscript=/usr/bin/vendor_perl -Dinc_version_list=none -Dman1ext=1perl -Dman3ext=3perl -Dcccdlflags='-fPIC' -Dlddlflags=-shared -Wl,-O1,--sort-common,--as-needed,-z,relro,-z,now -Dldflags=-Wl,-O1,--sort-common,--as-needed,-z,relro,-z,now'
    hint=recommended
    useposix=true
    d_sigaction=define
    useithreads=define
    usemultiplicity=define
    use64bitint=define
    use64bitall=define
    uselongdouble=undef
    usemymalloc=n
    default_inc_excludes_dot=define
    bincompat5005=undef
  Compiler:
    cc='cc'
    ccflags ='-D_REENTRANT -D_GNU_SOURCE -fwrapv -fno-strict-aliasing -pipe -fstack-protector-strong -I/usr/local/include -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64'
    optimize='-march=x86-64 -mtune=generic -O2 -pipe -fstack-protector-strong -fno-plt'
    cppflags='-D_REENTRANT -D_GNU_SOURCE -fwrapv -fno-strict-aliasing -pipe -fstack-protector-strong -I/usr/local/include'
    ccversion=''
    gccversion='8.2.1 20180831'
    gccosandvers=''
    intsize=4
    longsize=8
    ptrsize=8
    doublesize=8
    byteorder=12345678
    doublekind=3
    d_longlong=define
    longlongsize=8
    d_longdbl=define
    longdblsize=16
    longdblkind=3
    ivtype='long'
    ivsize=8
    nvtype='double'
    nvsize=8
    Off_t='off_t'
    lseeksize=8
    alignbytes=8
    prototype=define
  Linker and Libraries:
    ld='cc'
    ldflags ='-Wl,-O1,--sort-common,--as-needed,-z,relro,-z,now -fstack-protector-strong -L/usr/local/lib'
    libpth=/usr/local/lib /usr/lib/gcc/x86_64-pc-linux-gnu/8.2.1/include-fixed /usr/lib /lib/../lib /usr/lib/../lib /lib /lib64 /usr/lib64
    libs=-lpthread -lgdbm -ldb -ldl -lm -lcrypt -lutil -lc -lgdbm_compat
    perllibs=-lpthread -ldl -lm -lcrypt -lutil -lc
    libc=libc-2.28.so
    so=so
    useshrplib=true
    libperl=libperl.so
    gnulibc_version='2.28'
  Dynamic Linking:
    dlsrc=dl_dlopen.xs
    dlext=so
    d_dlsymun=undef
    ccdlflags='-Wl,-E -Wl,-rpath,/usr/lib/perl5/5.28/core_perl/CORE'
    cccdlflags='-fPIC'
    lddlflags='-shared -Wl,-O1,--sort-common,--as-needed,-z,relro,-z,now -L/usr/local/lib -fstack-protector-strong'



@INC for perl 5.28.1:
    lib
    /home/scp1/lib/perl5/x86_64-linux-thread-multi
    /home/scp1/lib/perl5
    /home/scp1/perl5/lib/perl5//5.28.1/x86_64-linux-thread-multi
    /home/scp1/perl5/lib/perl5//5.28.1
    /home/scp1/perl5/lib/perl5//x86_64-linux-thread-multi
    /home/scp1/perl5/lib/perl5/
    /usr/lib/perl5/5.28/site_perl
    /usr/share/perl5/site_perl
    /usr/lib/perl5/5.28/vendor_perl
    /usr/share/perl5/vendor_perl
    /usr/lib/perl5/5.28/core_perl
    /usr/share/perl5/core_perl


Environment for perl 5.28.1:
    HOME=/home/scp1
    LANG=en_US.UTF-8
    LANGUAGE (unset)
    LC_ADDRESS=en_US.UTF-8
    LC_ALL=
    LC_COLLATE=en_US.UTF-8
    LC_CTYPE=en_US.UTF-8
    LC_IDENTIFICATION=en_US.UTF-8
    LC_MEASUREMENT=en_US.UTF-8
    LC_MESSAGES=en_US.UTF-8
    LC_MONETARY=en_US.UTF-8
    LC_NAME=en_US.UTF-8
    LC_NUMERIC=en_US.UTF-8
    LC_PAPER=en_US.UTF-8
    LC_TELEPHONE=en_US.UTF-8
    LC_TIME=en_US.UTF-8
    LD_LIBRARY_PATH (unset)
    LOGDIR (unset)
    PATH=/home/scp1/perl5/bin:/home/scp1/dev/utils:/home/scp1/bin:/bin:/usr/local/bin:/usr/bin/core_perl:/usr/bin/core_perl/bin/:/usr/bin:/home/scp1/bin/site_perl:/usr/bin/vendor_perl:/sbin:/usr/sbin:/usr/games:/usr/local/games:/home/scp1/lib/go/bin:/home/scp1/perl6/bin:/home/scp1/.gem/ruby/2.5.0/bin
    PERL5LIB=/home/scp1/lib/perl5:/home/scp1/perl5/lib/perl5/
    PERLBREW_ROOT=/home/scp1/usr/share/perl5
    PERL_BADLANG (unset)
    PERL_CPANM_HOME=/home/scp1/tmp/cpanm
    PERL_CPANM_OPT=-nql~/ --reinstall --prompt --auto-cleanup 365 --mirror-only
    PERL_HACK_LIB=/home/scp1/dev/PERL_HACK_LIB
    PERL_LOCAL_LIB_ROOT=/home/scp1/perl5
    PERL_MB_OPT=--install_base "/home/scp1/perl5"
    PERL_MM_OPT=INSTALL_BASE=/home/scp1/perl5
    PERL_MM_USE_DEFAULT=0
    PERL_USE_UNSAFE_INC=1
    SHELL=/bin/zsh

@p5pRT
Copy link
Author

p5pRT commented Mar 6, 2019

From m@japh.se

0001-fix-readline-pod-error.patch
From 8764c58140303b635abdddbc8f952392ff4efcdf Mon Sep 17 00:00:00 2001
From: Magnus Woldrich <m@japh.se>
Date: Wed, 6 Mar 2019 07:26:29 +0100
Subject: [PATCH] fix readline pod error

---
 cpan/Pod-Perldoc/corpus/perlfunc.pod | 2 +-
 pod/perlfunc.pod                     | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/cpan/Pod-Perldoc/corpus/perlfunc.pod b/cpan/Pod-Perldoc/corpus/perlfunc.pod
index 604123daf8..83e9a55468 100644
--- a/cpan/Pod-Perldoc/corpus/perlfunc.pod
+++ b/cpan/Pod-Perldoc/corpus/perlfunc.pod
@@ -4970,7 +4970,7 @@ C<readline> and dies if the result is not defined.
         ...
     }
 
-Note that you have can't handle C<readline> errors that way with the
+Note that you can't handle C<readline> errors that way with the
 C<ARGV> filehandle. In that case, you have to open each element of
 C<@ARGV> yourself since C<eof> handles C<ARGV> differently.
 
diff --git a/pod/perlfunc.pod b/pod/perlfunc.pod
index 973a2612d7..2a24f2fc39 100644
--- a/pod/perlfunc.pod
+++ b/pod/perlfunc.pod
@@ -6219,7 +6219,7 @@ if the result is not defined.
         ...
     }
 
-Note that you have can't handle L<C<readline>|/readline EXPR> errors
+Note that you can't handle L<C<readline>|/readline EXPR> errors
 that way with the C<ARGV> filehandle.  In that case, you have to open
 each element of L<C<@ARGV>|perlvar/@ARGV> yourself since
 L<C<eof>|/eof FILEHANDLE> handles C<ARGV> differently.
-- 
2.20.1

@p5pRT
Copy link
Author

p5pRT commented Mar 6, 2019

From @jkeenan

On Wed, 06 Mar 2019 06​:34​:30 GMT, m@​japh.se wrote​:

This is a bug report for perl from m@​japh.se,
generated with the help of perlbug 1.41 running under perl 5.28.1.

-----------------------------------------------------------------
[Please describe your issue here]

The wording was a bit off in the readline docs in perlfunc.

The correction to pod/perlfunc.pod looks good.

The Pod-Perldoc distribution, however, is maintained upstream on CPAN, so any correction to cpan/Pod-Perldoc/corpus/*.pod ought to go upstream first (https://rt.cpan.org//Dist/Display.html?Queue=Pod-Perldoc).  Of course, the 'corpus' exists mainly for the upstream distribution to have representative POD to chew on. It's not documentation per se.

List​: Do we have any SOP on how to handle this?

Thank you very much.
--
James E Keenan (jkeenan@​cpan.org)

@p5pRT
Copy link
Author

p5pRT commented Mar 6, 2019

The RT System itself - Status changed from 'new' to 'open'

@khwilliamson
Copy link
Contributor

The patch affecting Perl has now been applied as f992105. The remainder could be submitted upstream, but as Jim said, that text could just as well be gibberish, as it is for testing only. So there isn't much point to correcting it.

Hence, I'm closing this ticket

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants