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

Pod-Usage: syntax error in documentation #15986

Closed
p5pRT opened this issue May 23, 2017 · 4 comments
Closed

Pod-Usage: syntax error in documentation #15986

p5pRT opened this issue May 23, 2017 · 4 comments

Comments

@p5pRT
Copy link

p5pRT commented May 23, 2017

Migrated from rt.perl.org#131346 (status was 'rejected')

Searchable as RT131346$

@p5pRT
Copy link
Author

p5pRT commented May 23, 2017

From molecules@cpan.org

This is a bug report for perl from molecules@​cpan.org,
generated with the help of perlbug 1.39 running under perl 5.14.2.

From c2ecb5475fe8877b5c83164131790be2b26e5868 Mon Sep 17 00​:00​:00 2001
From​: Christopher Bottoms <molecules@​cpan.org>
Date​: Tue, 23 May 2017 04​:04​:00 -0500
Subject​: [PATCH] semicolon added to correct SYNOPSIS


cpan/Pod-Usage/lib/Pod/Usage.pm | 2 +-
1 files changed, 1 insertions(+), 1 deletions(-)

Inline Patch
diff --git a/cpan/Pod-Usage/lib/Pod/Usage.pm b/cpan/Pod-Usage/lib/Pod/Usage.pm
index 8f79850..d4fcaee 100644
--- a/cpan/Pod-Usage/lib/Pod/Usage.pm
+++ b/cpan/Pod-Usage/lib/Pod/Usage.pm
@@ -379,7 +379,7 @@ Pod::Usage - print a usage message from embedded pod documentation
 
 =head1 SYNOPSIS
 
-  use Pod::Usage
+  use Pod::Usage;
 
   my $message_text  = "This text precedes the usage message.";
   my $exit_status   = 2;          ## The exit status to use
-- 
1.7.1

Flags​:
  category=library
  severity=low
  module=Pod​::Usage


Site configuration information for perl 5.14.2​:

Configured by root at Tue Nov 27 06​:46​:12 PST 2012.

Summary of my perl5 (revision 5 version 14 subversion 2) configuration​:
 
  Platform​:
  osname=linux, osvers=2.6.32-279.14.1.el6.x86_64, archname=x86_64-linux-thread-multi
  uname='linux centos-6-3.localdomain 2.6.32-279.14.1.el6.x86_64 #1 smp tue nov 6 23​:43​:09 utc 2012 x86_64 x86_64 x86_64 gnulinux '
  config_args='-Dprefix=/opt/perl -Dusethreads -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 -fno-strict-aliasing -pipe -fstack-protector -I/usr/local/include -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64',
  optimize='-O2',
  cppflags='-D_REENTRANT -D_GNU_SOURCE -fno-strict-aliasing -pipe -fstack-protector -I/usr/local/include'
  ccversion='', gccversion='4.4.6 20120305 (Red Hat 4.4.6-4)', 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/../lib64 /usr/lib/../lib64 /lib /usr/lib /lib64 /usr/lib64 /usr/local/lib64
  libs=-lnsl -ldb -ldl -lm -lcrypt -lutil -lpthread -lc
  perllibs=-lnsl -ldl -lm -lcrypt -lutil -lpthread -lc
  libc=, so=so, useshrplib=false, libperl=libperl.a
  gnulibc_version='2.12'
  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'

Locally applied patches​:
 


@​INC for perl 5.14.2​:
  /home/bottomsc/perl5/lib
  /home/bottomsc/perl5/lib/perl5/5.14.2/x86_64-linux-thread-multi
  /home/bottomsc/perl5/lib/perl5/5.14.2
  /home/bottomsc/perl5/lib/perl5/x86_64-linux-thread-multi
  /home/bottomsc/perl5/lib/perl5
  /opt/perl/lib/site_perl/5.14.2/x86_64-linux-thread-multi
  /opt/perl/lib/site_perl/5.14.2
  /opt/perl/lib/5.14.2/x86_64-linux-thread-multi
  /opt/perl/lib/5.14.2
  .


Environment for perl 5.14.2​:
  HOME=/home/bottomsc
  LANG=en_US.iso885915
  LANGUAGE (unset)
  LC_ALL=C
  LD_LIBRARY_PATH=/opt/openmpi/lib​:/usr/local/lib​:
  LOGDIR (unset)
  PATH=/share/apps/vim-8.0/bin​:/share/apps/emacs-24.5/bin​:/share/apps/perl6/rakudo-star-2016.11/install/share/perl6/site/bin​:/share/apps/perl6/rakudo-star-2016.11/install/bin​:/home/bottomsc/bin​:/home/bottomsc/bin_stahl​:/home/bottomsc/bashpack/scripts​:/home/bottomsc/local/bin​:/home/bottomsc/perl5/bin​:/opt/openmpi/bin​:/usr/lib64/qt-3.3/bin​:/opt/openlava-2.2/bin​:/opt/perl/bin​:/usr/local/bin​:/bin​:/usr/bin​:/usr/local/sbin​:/usr/sbin​:/sbin​:/opt/bio/ncbi/bin​:/opt/bio/mpiblast/bin​:/opt/bio/EMBOSS/bin​:/opt/bio/clustalw/bin​:/opt/bio/tcoffee/bin​:/opt/bio/hmmer/bin​:/opt/bio/phylip/exe​:/opt/bio/mrbayes​:/opt/bio/fasta​:/opt/bio/glimmer/bin​:/opt/bio/glimmer/scripts​:/opt/bio/gromacs/bin​:/opt/bio/gmap/bin​:/opt/bio/tigr/bin​:/opt/bio/autodocksuite/bin​:/opt/bio/wgs/bin​:/opt/ganglia/bin​:/opt/ganglia/sbin​:/share/ircf/ircfapps/bin​:/usr/java/latest/bin​:/opt/maven/bin​:/opt/pdsh/bin​:/opt/rocks/bin​:/opt/rocks/sbin
  PERL5LIB=/home/bottomsc/perl5/lib​:/home/bottomsc/perl5/lib/perl5​:
  PERLDEV=/share/data/bottomsc/Perl5
  PERL_BADLANG (unset)
  SHELL=/bin/bash

@p5pRT
Copy link
Author

p5pRT commented May 23, 2017

From @jkeenan

On Tue, 23 May 2017 09​:16​:24 GMT, molecules@​cpan.org wrote​:

This is a bug report for perl from molecules@​cpan.org,
generated with the help of perlbug 1.39 running under perl 5.14.2.

From c2ecb5475fe8877b5c83164131790be2b26e5868 Mon Sep 17 00​:00​:00 2001
From​: Christopher Bottoms <molecules@​cpan.org>
Date​: Tue, 23 May 2017 04​:04​:00 -0500
Subject​: [PATCH] semicolon added to correct SYNOPSIS

---
cpan/Pod-Usage/lib/Pod/Usage.pm | 2 +-
1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/cpan/Pod-Usage/lib/Pod/Usage.pm b/cpan/Pod-
Usage/lib/Pod/Usage.pm
index 8f79850..d4fcaee 100644
--- a/cpan/Pod-Usage/lib/Pod/Usage.pm
+++ b/cpan/Pod-Usage/lib/Pod/Usage.pm
@​@​ -379,7 +379,7 @​@​ Pod​::Usage - print a usage message from embedded
pod documentation

=head1 SYNOPSIS

- use Pod​::Usage
+ use Pod​::Usage;

my $message_text = "This text precedes the usage message.";
my $exit_status = 2; ## The exit status to use

Thank you for the patch. Pod-Usage is included in the Perl 5 core distribution but is maintained upstream on CPAN. As a matter of fact, this same defect was reported in Pod-Usage's bug tracker almost a year ago to the day. See​:

https://rt.cpan.org/Public/Bug/Display.html?id=114697

I'm going to close this ticket but will add an entry to CPAN 114697 noting that the error still exists.

Thank you very much.

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

@p5pRT
Copy link
Author

p5pRT commented May 23, 2017

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

@p5pRT
Copy link
Author

p5pRT commented May 23, 2017

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

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