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

Typo for PERL5LIB doc in perlrun #16486

Closed
p5pRT opened this issue Mar 30, 2018 · 7 comments
Closed

Typo for PERL5LIB doc in perlrun #16486

p5pRT opened this issue Mar 30, 2018 · 7 comments

Comments

@p5pRT
Copy link

p5pRT commented Mar 30, 2018

Migrated from rt.perl.org#133044 (status was 'resolved')

Searchable as RT133044$

@p5pRT
Copy link
Author

p5pRT commented Mar 30, 2018

From @KES777

Created by @KES777

Please fix the typo for PERL5LIB doc in perlrun

Only the -[CDIMUdmtwW] switches are allowed
and later in text​:
If PERL5OPT begins with -T
so -T option is allowed and should be listed as allowed

Perl Info

Flags:
    category=docs
    severity=low

Site configuration information for perl 5.24.0:

Configured by kes at Wed Oct 19 14:07:47 EEST 2016.

Summary of my perl5 (revision 5 version 24 subversion 0) configuration:
   
  Platform:
    osname=linux, osvers=4.4.0-43-generic, archname=x86_64-linux
    uname='linux work 4.4.0-43-generic #63-ubuntu smp wed oct 12 13:48:03 utc 2016 x86_64 x86_64 x86_64 gnulinux '
    config_args='-de -Dprefix=/home/kes/perl5/perlbrew/perls/perl-5.24.0 -Aeval:scriptdir=/home/kes/perl5/perlbrew/perls/perl-5.24.0/bin'
    hint=recommended, useposix=true, d_sigaction=define
    useithreads=undef, usemultiplicity=undef
    use64bitint=define, use64bitall=define, uselongdouble=undef
    usemymalloc=n, bincompat5005=undef
  Compiler:
    cc='cc', ccflags ='-fwrapv -fno-strict-aliasing -pipe -fstack-protector-strong -I/usr/local/include -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64',
    optimize='-O2',
    cppflags='-fwrapv -fno-strict-aliasing -pipe -fstack-protector-strong -I/usr/local/include'
    ccversion='', gccversion='5.4.0 20160609', 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 =' -fstack-protector-strong -L/usr/local/lib'
    libpth=/usr/local/lib /usr/lib/gcc/x86_64-linux-gnu/5/include-fixed /usr/include/x86_64-linux-gnu /usr/lib /lib/x86_64-linux-gnu /lib/../lib /usr/lib/x86_64-linux-gnu /usr/lib/../lib /lib /lib64 /usr/lib64
    libs=-lpthread -lnsl -ldl -lm -lcrypt -lutil -lc
    perllibs=-lpthread -lnsl -ldl -lm -lcrypt -lutil -lc
    libc=libc-2.23.so, so=so, useshrplib=false, libperl=libperl.a
    gnulibc_version='2.23'
  Dynamic Linking:
    dlsrc=dl_dlopen.xs, dlext=so, d_dlsymun=undef, ccdlflags='-Wl,-E'
    cccdlflags='-fPIC', lddlflags='-shared -O2 -L/usr/local/lib -fstack-protector-strong'

Locally applied patches:
    Devel::PatchPerl 1.38


@INC for perl 5.24.0:
    /home/kes/perl5/perlbrew/perls/perl-5.24.0/lib/site_perl/5.24.0/x86_64-linux
    /home/kes/perl5/perlbrew/perls/perl-5.24.0/lib/site_perl/5.24.0
    /home/kes/perl5/perlbrew/perls/perl-5.24.0/lib/5.24.0/x86_64-linux
    /home/kes/perl5/perlbrew/perls/perl-5.24.0/lib/5.24.0
    .


Environment for perl 5.24.0:
    HOME=/home/kes
    LANG=en_US.UTF-8
    LANGUAGE=en
    LC_ADDRESS=uk_UA.UTF-8
    LC_IDENTIFICATION=uk_UA.UTF-8
    LC_MEASUREMENT=uk_UA.UTF-8
    LC_MESSAGES=en_US.UTF-8
    LC_MONETARY=uk_UA.UTF-8
    LC_NAME=uk_UA.UTF-8
    LC_NUMERIC=uk_UA.UTF-8
    LC_PAPER=uk_UA.UTF-8
    LC_TELEPHONE=uk_UA.UTF-8
    LD_LIBRARY_PATH (unset)
    LOGDIR (unset)
    PATH=/home/kes/perl5/perlbrew/bin:/home/kes/perl5/perlbrew/perls/perl-5.24.0/bin:/home/kes/bin:/home/kes/bin:/home/kes/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games
    PERLBREW=command perlbrew
    PERLBREW_BASHRC_VERSION=0.78
    PERLBREW_HOME=/home/kes/.perlbrew
    PERLBREW_MANPATH=/home/kes/perl5/perlbrew/perls/perl-5.24.0/man
    PERLBREW_PATH=/home/kes/perl5/perlbrew/bin:/home/kes/perl5/perlbrew/perls/perl-5.24.0/bin
    PERLBREW_PERL=perl-5.24.0
    PERLBREW_ROOT=/home/kes/perl5/perlbrew
    PERLBREW_VERSION=0.78
    PERL_BADLANG (unset)
    SHELL=/bin/bash

@p5pRT
Copy link
Author

p5pRT commented Sep 3, 2018

From @jkeenan

On Fri, 30 Mar 2018 17​:22​:57 GMT, kes-kes@​yandex.ru wrote​:

This is a bug report for perl from kes-kes@​yandex.ru,
generated with the help of perlbug 1.40 running under perl 5.24.0.

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

Please fix the typo for PERL5LIB doc in perlrun

Only the -[CDIMUdmtwW] switches are allowed
and later in text​:
If PERL5OPT begins with -T
so -T option is allowed and should be listed as allowed

I'm confused about this report, because neither of the two text fragments you quote appear in the PERL5LIB section.

Here is the entire content of the PERL5LIB section of pod/perlrun.pod (blead) (line lengths trimmed to look better in RT)​:

#####
=item PERL5LIB
X<PERL5LIB>

A list of directories in which to look for Perl
library files before looking in the standard
library. Any architecture-specific and
version-specific directories, such as
F<version/archname/>, F<version/>, or F<archname/>
under the specified locations are automatically
included if they exist, with this lookup done at
interpreter startup time. In addition, any
directories matching the entries in
C<$Config{inc_version_list}> are added. (These
typically would be for older compatible perl
versions installed in the same directory tree.)

If PERL5LIB is not defined, PERLLIB is used.
Directories are separated (like in PATH) by a
colon on Unixish platforms and by a semicolon on
Windows (the proper path separator being given by
the command C<perl -V​:I<path_sep>>).

When running taint checks, either because the
program was running setuid or setgid, or the B<-T>
or B<-t> switch was specified, neither PERL5LIB
nor PERLLIB is consulted. The program should
instead say​:

  use lib "/my/directory";

#####

Is there anything amiss in *that* section?

Thank you very much.

--
James E Keenan (jkeenan@​cpan.org)

@p5pRT
Copy link
Author

p5pRT commented Sep 3, 2018

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

@p5pRT
Copy link
Author

p5pRT commented Sep 4, 2018

From @KES777

I am sorry. This section​:

  PERL5OPT Command-line options (switches). Switches in this variable are
  treated as if they were on every Perl command line. Only the
  -[CDIMUdmtwW] switches are allowed. When running taint checks
  (either because the program was running setuid or setgid, or
  because the -T or -t switch was used), this variable is
  ignored. If PERL5OPT begins with -T, tainting will be enabled
  and subsequent options ignored. If PERL5OPT begins with -t,
  tainting will be enabled, a writable dot removed from @​INC,
  and subsequent options honored.

As you can see -T option is not listed as allowed​:

  [CDIMUdmtwW] switches are allowed

@p5pRT
Copy link
Author

p5pRT commented Sep 4, 2018

From @jkeenan

On Tue, 04 Sep 2018 07​:48​:10 GMT, kes-kes@​yandex.ru wrote​:

I am sorry. This section​:

PERL5OPT Command-line options (switches). Switches in this variable
are
treated as if they were on every Perl command line. Only
the
-[CDIMUdmtwW] switches are allowed. When running taint
checks
(either because the program was running setuid or setgid,
or
because the -T or -t switch was used), this variable is
ignored. If PERL5OPT begins with -T, tainting will be
enabled
and subsequent options ignored. If PERL5OPT begins with
-t,
tainting will be enabled, a writable dot removed from
@​INC,
and subsequent options honored.

As you can see -T option is not listed as allowed​:

[CDIMUdmtwW] switches are allowed

Thanks. I fixed this in commit 3809fbe and sorted the switches to group upper-case and lower-case switches separately.

Please review. Am taking this RT for the purpose of closing it in a few days unless someone objects.

Thank you very much.

--
James E Keenan (jkeenan@​cpan.org)

@p5pRT
Copy link
Author

p5pRT commented Sep 6, 2018

From @jkeenan

On Tue, 04 Sep 2018 13​:58​:57 GMT, jkeenan wrote​:

On Tue, 04 Sep 2018 07​:48​:10 GMT, kes-kes@​yandex.ru wrote​:

I am sorry. This section​:

PERL5OPT Command-line options (switches). Switches in this
variable
are
treated as if they were on every Perl command line. Only
the
-[CDIMUdmtwW] switches are allowed. When running taint
checks
(either because the program was running setuid or setgid,
or
because the -T or -t switch was used), this variable is
ignored. If PERL5OPT begins with -T, tainting will be
enabled
and subsequent options ignored. If PERL5OPT begins with
-t,
tainting will be enabled, a writable dot removed from
@​INC,
and subsequent options honored.

As you can see -T option is not listed as allowed​:

[CDIMUdmtwW] switches are allowed

Thanks. I fixed this in commit
3809fbe and sorted the switches to
group upper-case and lower-case switches separately.

Please review. Am taking this RT for the purpose of closing it in a
few days unless someone objects.

Thank you very much.

No objections heard, so I'm marking this ticket resolved. I believe it should be considered for backporting to perl-5.26.3 and perl-5.28.1, so I'm linking to the respective meta-tickets.

Thank you very much.

--
James E Keenan (jkeenan@​cpan.org)

@p5pRT
Copy link
Author

p5pRT commented Sep 6, 2018

@jkeenan - Status changed from 'open' to 'resolved'

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

1 participant