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 in documentation of "say" on perldoc.perl.org #15075

Closed
p5pRT opened this issue Dec 6, 2015 · 10 comments
Closed

Typo in documentation of "say" on perldoc.perl.org #15075

p5pRT opened this issue Dec 6, 2015 · 10 comments

Comments

@p5pRT
Copy link

p5pRT commented Dec 6, 2015

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

Searchable as RT126833$

@p5pRT
Copy link
Author

p5pRT commented Dec 6, 2015

From @rrthomas

Created by @rrthomas

On the page http​://perldoc.perl.org/functions/say.html it says​:

Alternately, include a use v5.10 or later to the current scope.

However, that would require perl 5.100 or later.

Instead of “use v5.10” it should say “use 5.10.0”.

Perl Info

Flags:
    category=docs
    severity=low

Site configuration information for perl 5.18.2:

Configured by Debian Project at Thu Mar 27 18:28:21 UTC 2014.

Summary of my perl5 (revision 5 version 18 subversion 2) configuration:
   
  Platform:
    osname=linux, osvers=3.2.0-58-generic, archname=x86_64-linux-gnu-thread-multi
    uname='linux brownie 3.2.0-58-generic #88-ubuntu smp tue dec 3 17:37:58 utc 2013 x86_64 x86_64 x86_64 gnulinux '
    config_args='-Dusethreads -Duselargefiles -Dccflags=-DDEBIAN -D_FORTIFY_SOURCE=2 -g -O2 -fstack-protector --param=ssp-buffer-size=4 -Wformat -Werror=format-security -Dldflags= -Wl,-Bsymbolic-functions -Wl,-z,relro -Dlddlflags=-shared -Wl,-Bsymbolic-functions -Wl,-z,relro -Dcccdlflags=-fPIC -Darchname=x86_64-linux-gnu -Dprefix=/usr -Dprivlib=/usr/share/perl/5.18 -Darchlib=/usr/lib/perl/5.18 -Dvendorprefix=/usr -Dvendorlib=/usr/share/perl5 -Dvendorarch=/usr/lib/perl5 -Dsiteprefix=/usr/local -Dsitelib=/usr/local/share/perl/5.18.2 -Dsitearch=/usr/local/lib/perl/5.18.2 -Dman1dir=/usr/share/man/man1 -Dman3dir=/usr/share/man/man3 -Dsiteman1dir=/usr/local/man/man1 -Dsiteman3dir=/usr/local/man/man3 -Duse64bitint -Dman1ext=1 -Dman3ext=3perl -Dpager=/usr/bin/sensible-pager -Uafs -Ud_csh -Ud_ualarm -Uusesfio -Uusenm -Ui_libutil -Uversiononly -DDEBUGGING=-g -Doptimize=-O2 -Duseshrplib -Dlibperl=libperl.so.5.18.2 -des'
    hint=recommended, useposix=true, d_sigaction=define
    useithreads=define, usemultiplicity=define
    useperlio=define, d_sfio=undef, uselargefiles=define, usesocks=undef
    use64bitint=define, use64bitall=define, uselongdouble=undef
    usemymalloc=n, bincompat5005=undef
  Compiler:
    cc='cc', ccflags ='-D_REENTRANT -D_GNU_SOURCE -DDEBIAN -fstack-protector -fno-strict-aliasing -pipe -I/usr/local/include -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64',
    optimize='-O2 -g',
    cppflags='-D_REENTRANT -D_GNU_SOURCE -DDEBIAN -fstack-protector -fno-strict-aliasing -pipe -I/usr/local/include'
    ccversion='', gccversion='4.8.2', gccosandvers=''
    intsize=4, longsize=8, ptrsize=8, doublesize=8, byteorder=12345678
    d_longlong=define, longlongsize=8, d_longdbl=define, longdblsize=16
    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 -L/usr/local/lib'
    libpth=/usr/local/lib /lib/x86_64-linux-gnu /lib/../lib /usr/lib/x86_64-linux-gnu /usr/lib/../lib /lib /usr/lib
    libs=-lgdbm -lgdbm_compat -ldb -ldl -lm -lpthread -lc -lcrypt
    perllibs=-ldl -lm -lpthread -lc -lcrypt
    libc=, so=so, useshrplib=true, libperl=libperl.so.5.18.2
    gnulibc_version='2.19'
  Dynamic Linking:
    dlsrc=dl_dlopen.xs, dlext=so, d_dlsymun=undef, ccdlflags='-Wl,-E'
    cccdlflags='-fPIC', lddlflags='-shared -L/usr/local/lib -fstack-protector'

Locally applied patches:
    DEBPKG:debian/cpan_definstalldirs - Provide a sensible INSTALLDIRS default for modules installed from CPAN.
    DEBPKG:debian/db_file_ver - http://bugs.debian.org/340047 Remove overly restrictive DB_File version check.
    DEBPKG:debian/doc_info - Replace generic man(1) instructions with Debian-specific information.
    DEBPKG:debian/enc2xs_inc - http://bugs.debian.org/290336 Tweak enc2xs to follow symlinks and ignore missing @INC directories.
    DEBPKG:debian/errno_ver - http://bugs.debian.org/343351 Remove Errno version check due to upgrade problems with long-running processes.
    DEBPKG:debian/libperl_embed_doc - http://bugs.debian.org/186778 Note that libperl-dev package is required for embedded linking
    DEBPKG:fixes/respect_umask - Respect umask during installation
    DEBPKG:debian/writable_site_dirs - Set umask approproately for site install directories
    DEBPKG:debian/extutils_set_libperl_path - EU:MM: Set location of libperl.a to /usr/lib
    DEBPKG:debian/no_packlist_perllocal - Don't install .packlist or perllocal.pod for perl or vendor
    DEBPKG:debian/prefix_changes - Fiddle with *PREFIX and variables written to the makefile
    DEBPKG:debian/fakeroot - Postpone LD_LIBRARY_PATH evaluation to the binary targets.
    DEBPKG:debian/instmodsh_doc - Debian policy doesn't install .packlist files for core or vendor.
    DEBPKG:debian/ld_run_path - Remove standard libs from LD_RUN_PATH as per Debian policy.
    DEBPKG:debian/libnet_config_path - Set location of libnet.cfg to /etc/perl/Net as /usr may not be writable.
    DEBPKG:debian/mod_paths - Tweak @INC ordering for Debian
    DEBPKG:debian/module_build_man_extensions - http://bugs.debian.org/479460 Adjust Module::Build manual page extensions for the Debian Perl policy
    DEBPKG:debian/prune_libs - http://bugs.debian.org/128355 Prune the list of libraries wanted to what we actually need.
    DEBPKG:fixes/net_smtp_docs - [rt.cpan.org #36038] http://bugs.debian.org/100195 Document the Net::SMTP 'Port' option
    DEBPKG:debian/perlivp - http://bugs.debian.org/510895 Make perlivp skip include directories in /usr/local
    DEBPKG:debian/cpanplus_definstalldirs - http://bugs.debian.org/533707 Configure CPANPLUS to use the site directories by default.
    DEBPKG:debian/cpanplus_config_path - Save local versions of CPANPLUS::Config::System into /etc/perl.
    DEBPKG:debian/deprecate-with-apt - http://bugs.debian.org/702096 Point users to Debian packages of deprecated core modules
    DEBPKG:debian/squelch-locale-warnings - http://bugs.debian.org/508764 Squelch locale warnings in Debian package maintainer scripts
    DEBPKG:debian/skip-upstream-git-tests - Skip tests specific to the upstream Git repository
    DEBPKG:debian/patchlevel - http://bugs.debian.org/567489 List packaged patches for 5.18.2-2ubuntu1 in patchlevel.h
    DEBPKG:debian/skip-kfreebsd-crash - http://bugs.debian.org/628493 [perl #96272] Skip a crashing test case in t/op/threads.t on GNU/kFreeBSD
    DEBPKG:fixes/document_makemaker_ccflags - http://bugs.debian.org/628522 [rt.cpan.org #68613] Document that CCFLAGS should include $Config{ccflags}
    DEBPKG:debian/find_html2text - http://bugs.debian.org/640479 Configure CPAN::Distribution with correct name of html2text
    DEBPKG:debian/hurd_test_skip_stack - http://bugs.debian.org/650175 Disable failing GNU/Hurd tests dist/threads/t/stack.t
    DEBPKG:fixes/manpage_name_Test-Harness - http://bugs.debian.org/650451 [rt.cpan.org #73399] cpan/Test-Harness: add NAME headings in modules with POD
    DEBPKG:debian/makemaker-pasthru - http://bugs.debian.org/660195 [rt.cpan.org #28632] Make EU::MM pass LD through to recursive Makefile.PL invocations
    DEBPKG:debian/perl5db-x-terminal-emulator.patch - http://bugs.debian.org/668490 Invoke x-terminal-emulator rather than xterm in perl5db.pl
    DEBPKG:debian/cpan-missing-site-dirs - http://bugs.debian.org/688842 Fix CPAN::FirstTime defaults with nonexisting site dirs if a parent is writable
    DEBPKG:fixes/memoize_storable_nstore - [rt.cpan.org #77790] http://bugs.debian.org/587650 Memoize::Storable: respect 'nstore' option not respected
    DEBPKG:fixes/net_ftp_failed_command - [rt.cpan.org #37700] http://bugs.debian.org/491062 Net::FTP: cope gracefully with a failed command
    DEBPKG:fixes/perlbug-patchlist - [3541c11] http://bugs.debian.org/710842 [perl #118433] Make perlbug look up the list of local patches at run time
    DEBPKG:fixes/module_metadata_security_doc - [68cdd4b] CVE-2013-1437 documentation fix
    DEBPKG:fixes/module_metadata_taint_fix - [bff978f] http://bugs.debian.org/722210 [rt.cpan.org #88576] untaint version, if needed, in Module::Metadata
    DEBPKG:fixes/IPC-SysV-spelling - http://bugs.debian.org/730558 [rt.cpan.org #86736] Fix spelling of IPC_CREAT in IPC-SysV documentation
    DEBPKG:fixes/fix-undef-source -


@INC for perl 5.18.2:
    /home/rrt/.local/x86_64-linux-gnu-thread-multi/lib/perl/5.18.2
    /home/rrt/.local/share/perl/5.18.2
    /home/rrt/.local/share/perl
    /etc/perl
    /usr/local/lib/perl/5.18.2
    /usr/local/share/perl/5.18.2
    /usr/lib/perl5
    /usr/share/perl5
    /usr/lib/perl/5.18
    /usr/share/perl/5.18
    /usr/local/lib/site_perl
    .


Environment for perl 5.18.2:
    HOME=/home/rrt
    LANG=en_GB.UTF-8
    LANGUAGE=en_GB
    LC_ADDRESS=en_GB.UTF-8
    LC_IDENTIFICATION=en_GB.UTF-8
    LC_MEASUREMENT=en_GB.UTF-8
    LC_MONETARY=en_GB.UTF-8
    LC_NAME=en_GB.UTF-8
    LC_NUMERIC=en_GB.UTF-8
    LC_PAPER=en_GB.UTF-8
    LC_TELEPHONE=en_GB.UTF-8
    LC_TIME=en_GB.UTF-8
    LD_LIBRARY_PATH=/home/rrt/.local/lib/x86_64-linux-gnu
    LOGDIR (unset)
    PATH=/home/rrt/.local/lib/luarocks/rocks-5.3/cw/git-1/libexec/cw:/home/rrt/.local/bin/override:/home/rrt/.local/bin/x86_64-linux-gnu:/home/rrt/.local/bin:/home/rrt/.cabal/bin:/home/rrt/.gem/ruby/1.9.1/bin:/usr/lib/ccache:/home/rrt/repo/mxe/usr/bin:/usr/local/djgpp-cross/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/home/rrt/.local/lib/go/bin:/home/rrt/Work/Adsensus/git-svn/adsensus/trunk
    PERL5LIB=/home/rrt/.local/x86_64-linux-gnu-thread-multi/lib/perl/5.18.2:/home/rrt/.local/share/perl
    PERL_BADLANG (unset)
    SHELL=/bin/bash

@p5pRT
Copy link
Author

p5pRT commented Dec 6, 2015

From @rrthomas

On Sun Dec 06 09​:10​:24 2015, rrt wrote​:

Alternately, include a use v5.10 or later to the current scope.

On a second reading, I note this should also be changed to say either "include…in" or "add…to", rather than "include…to" as at present.

@p5pRT
Copy link
Author

p5pRT commented Dec 6, 2015

From [Unknown Contact. See original ticket]

On Sun Dec 06 09​:10​:24 2015, rrt wrote​:

Alternately, include a use v5.10 or later to the current scope.

On a second reading, I note this should also be changed to say either "include…in" or "add…to", rather than "include…to" as at present.

@p5pRT
Copy link
Author

p5pRT commented Dec 6, 2015

From madcityzen@gmail.com

On Dec 6, 2015, at 11​:13 AM, rrt@​sc3d.org via RT <perlbug-comment@​perl.org> wrote​:

On Sun Dec 06 09​:10​:24 2015, rrt wrote​:

Alternately, include a use v5.10 or later to the current scope.

On a second reading, I note this should also be changed to say either "include…in" or "add…to", rather than "include…to" as at present.

I've attached a patch to fix the wording, but the "use v5.10" is correct​:

  $ perl -e'use v5.10; say "Hello"'
  Hello

Perl splits version strings on "." and prefixes zeros (like `sprintf "%03d"`). The leading "v" is what says to do this. Without that leading "v", you would need to say "use 5.010".

Doug Bell
madcityzen@​gmail.com

@p5pRT
Copy link
Author

p5pRT commented Dec 6, 2015

From madcityzen@gmail.com

0001-fix-awkward-wording-in-say-documentation.patch
From 901949680f496040adee747d50a64510116632f9 Mon Sep 17 00:00:00 2001
From: Doug Bell <madcityzen@gmail.com>
Date: Sun, 6 Dec 2015 12:33:26 -0600
Subject: [PATCH] fix awkward wording in say documentation

---
 pod/perlfunc.pod | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/pod/perlfunc.pod b/pod/perlfunc.pod
index 41d0be0..72e62a5 100644
--- a/pod/perlfunc.pod
+++ b/pod/perlfunc.pod
@@ -6157,7 +6157,7 @@ use a real filehandle like C<FH>, not an indirect one like C<$fh>.
 
 This keyword is available only when the C<"say"> feature
 is enabled, or when prefixed with C<CORE::>; see
-L<feature>.  Alternately, include a C<use v5.10> or later to the current
+L<feature>.  Alternately, add a C<use v5.10> or later to the current
 scope.
 
 =item scalar EXPR
-- 
2.4.9 (Apple Git-60)

@p5pRT
Copy link
Author

p5pRT commented Dec 7, 2015

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

@p5pRT
Copy link
Author

p5pRT commented Dec 7, 2015

From @mauke

Am So 06. Dez 2015, 09​:10​:24, rrt schrieb​:

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

On the page http​://perldoc.perl.org/functions/say.html it says​:

Alternately, include a use v5.10 or later to the current scope.

However, that would require perl 5.100 or later.

Instead of “use v5.10” it should say “use 5.10.0”.

No, that's wrong. Did you try it?

"use v5.10", "use v5.10.0", "use 5.10.0", "use 5.010" all mean the same thing.

@p5pRT
Copy link
Author

p5pRT commented Dec 7, 2015

From @rrthomas

Apologies, I must've typed "use 5.10;".

The second part of my correction still stands.

On 7 December 2015 at 06​:29, l.mai@​web.de via RT <perlbug-followup@​perl.org>
wrote​:

Am So 06. Dez 2015, 09​:10​:24, rrt schrieb​:

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

On the page http​://perldoc.perl.org/functions/say.html it says​:

Alternately, include a use v5.10 or later to the current scope.

However, that would require perl 5.100 or later.

Instead of “use v5.10” it should say “use 5.10.0”.

No, that's wrong. Did you try it?

"use v5.10", "use v5.10.0", "use 5.10.0", "use 5.010" all mean the same
thing.

--
http​://rrt.sc3d.org

@p5pRT
Copy link
Author

p5pRT commented Dec 10, 2015

From @jkeenan

On Sun Dec 06 10​:41​:39 2015, madcityzen@​gmail.com wrote​:

On Dec 6, 2015, at 11​:13 AM, rrt@​sc3d.org via RT <perlbug-
comment@​perl.org> wrote​:

On Sun Dec 06 09​:10​:24 2015, rrt wrote​:

Alternately, include a use v5.10 or later to the current scope.

On a second reading, I note this should also be changed to say either
"include…in" or "add…to", rather than "include…to" as at present.

I've attached a patch to fix the wording, but the "use v5.10" is
correct​:

$ perl -e'use v5.10; say "Hello"'
Hello

Perl splits version strings on "." and prefixes zeros (like `sprintf
"%03d"`). The leading "v" is what says to do this. Without that
leading "v", you would need to say "use 5.010".

Doug Bell
madcityzen@​gmail.com

Thanks. Pushed to blead in commit 598b145.

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

@p5pRT p5pRT closed this as completed Dec 10, 2015
@p5pRT
Copy link
Author

p5pRT commented Dec 10, 2015

@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