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

[PATCH] Better titles on deleted documents #13229

Closed
p5pRT opened this issue Sep 5, 2013 · 6 comments
Closed

[PATCH] Better titles on deleted documents #13229

p5pRT opened this issue Sep 5, 2013 · 6 comments

Comments

@p5pRT
Copy link

p5pRT commented Sep 5, 2013

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

Searchable as RT119615$

@p5pRT
Copy link
Author

p5pRT commented Sep 5, 2013

From @Smylers

This is a bug report for perl from smylers@​stripey.com,
generated with the help of perlbug 1.39 running under perl 5.19.4.


Improve the deleted document stubs, including giving them more helpful
titles, following Father Chrysostomos's comment here​:
https://rt-archive.perl.org/perl5/Ticket/Display.html?id=119571#txn-1250649

Patch to follow.



Flags​:
  category=docs
  severity=low


Site configuration information for perl 5.19.4​:

Configured by smylers at Tue Sep 3 10​:58​:31 BST 2013.

Summary of my perl5 (revision 5 version 19 subversion 4) configuration​:
  Commit id​: 5565c73
  Platform​:
  osname=linux, osvers=3.8.0-30-generic, archname=x86_64-linux
  uname='linux fozzie 3.8.0-30-generic #44-ubuntu smp thu aug 22 20​:52​:24 utc 2013 x86_64 x86_64 x86_64 gnulinux '
  config_args='-des -Dusedevel'
  hint=recommended, useposix=true, d_sigaction=define
  useithreads=undef, usemultiplicity=undef
  useperlio=define, d_sfio=undef, uselargefiles=define, usesocks=undef
  use64bitint=define, use64bitall=define, uselongdouble=undef
  usemymalloc=n, bincompat5005=undef
  Compiler​:
  cc='cc', ccflags ='-fno-strict-aliasing -pipe -fstack-protector -I/usr/local/include -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64',
  optimize='-O2',
  cppflags='-fno-strict-aliasing -pipe -fstack-protector -I/usr/local/include'
  ccversion='', gccversion='4.7.3', 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=-lnsl -ldl -lm -lcrypt -lutil -lc
  perllibs=-lnsl -ldl -lm -lcrypt -lutil -lc
  libc=, so=so, useshrplib=false, libperl=libperl.a
  gnulibc_version='2.17'
  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'


@​INC for perl 5.19.4​:
  lib
  /home/smylers/lib/perl5/site_perl
  /home/smylers/lib/perl5
  /usr/local/lib/perl5/site_perl/5.19.4/x86_64-linux
  /usr/local/lib/perl5/site_perl/5.19.4
  /usr/local/lib/perl5/5.19.4/x86_64-linux
  /usr/local/lib/perl5/5.19.4
  .


Environment for perl 5.19.4​:
  HOME=/home/smylers
  LANG=en_GB.utf8
  LANGUAGE=en_GB​:en
  LC_COLLATE=C
  LD_LIBRARY_PATH (unset)
  LOGDIR (unset)
  PATH=/home/smylers/bin​:/usr/local/sbin​:/usr/local/bin​:/sbin​:/bin​:/usr/sbin​:/usr/bin​:/usr/X11R6/bin​:/usr/games
  PERL5LIB=/home/smylers/lib/perl5/site_perl​:/home/smylers/lib/perl5
  PERL_BADLANG (unset)
  PERL_CPANM_OPT=--sudo --prompt
  SHELL=/bin/bash

@p5pRT
Copy link
Author

p5pRT commented Sep 5, 2013

From @Smylers

Patch attached. Also fixes a couple of other small matters relating to
deleted documents.

Smylers
--
Stop drug companies hiding negative research results.
Sign the AllTrials petition to get all clinical research results published.
Read more​: http​://www.alltrials.net/blog/the-alltrials-campaign/

@p5pRT
Copy link
Author

p5pRT commented Sep 5, 2013

From @Smylers

deleted_docs.patch
From 47a29da9f05415fbc2f8f28147f3c0b1fe98f69d Mon Sep 17 00:00:00 2001
From: Smylers <Smylers@stripey.com>
Date: Thu, 5 Sep 2013 11:01:53 +0100
Subject: [PATCH 1/4] List deleted docs alphabetically
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="------------1.8.1.2"

This is a multi-part message in MIME format.
--------------1.8.1.2
Content-Type: text/plain; charset=UTF-8; format=fixed
Content-Transfer-Encoding: 8bit


perlrepository was added at the end in 5edbc4ff, when I apparently failed
to notice the list was in alphabetical order.

For RT #119615.
---
 pod/perl.pod | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)


--------------1.8.1.2
Content-Type: text/x-patch; name="0001-List-deleted-docs-alphabetically.patch"
Content-Transfer-Encoding: 8bit
Content-Disposition: attachment; filename="0001-List-deleted-docs-alphabetically.patch"

diff --git a/pod/perl.pod b/pod/perl.pod
index 7ff91e4..b14624d 100644
--- a/pod/perl.pod
+++ b/pod/perl.pod
@@ -268,10 +268,10 @@ aux a2p c2ph h2ph h2xs perlbug pl2pm pod2html pod2man s2p splain xsubpp
 
     perlboot		
     perlbot		
+    perlrepository
     perltodo
     perltooc		
     perltoot		
-    perlrepository
 
 =for buildtoc __END__
 

--------------1.8.1.2--



From 6510261c3e14abfdf348bbab1cc54495678d6605 Mon Sep 17 00:00:00 2001
From: Smylers <Smylers@stripey.com>
Date: Thu, 5 Sep 2013 11:14:04 +0100
Subject: [PATCH 2/4] Add missing word
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="------------1.8.1.2"

This is a multi-part message in MIME format.
--------------1.8.1.2
Content-Type: text/plain; charset=UTF-8; format=fixed
Content-Transfer-Encoding: 8bit


For RT #119615.
---
 pod/perltodo.pod | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)


--------------1.8.1.2
Content-Type: text/x-patch; name="0002-Add-missing-word.patch"
Content-Transfer-Encoding: 8bit
Content-Disposition: attachment; filename="0002-Add-missing-word.patch"

diff --git a/pod/perltodo.pod b/pod/perltodo.pod
index 524a501..20059ca 100644
--- a/pod/perltodo.pod
+++ b/pod/perltodo.pod
@@ -4,7 +4,7 @@ perltodo - Perl TO-DO List
 
 =head1 DESCRIPTION
 
-We no longer install the Perl 5 to-do list as a manpage, as installing
+We no longer install the Perl 5 to-do list as a manpage, as installing a
 snapshot that becomes increasingly out of date isn't that useful to anyone.
 The current Perl 5 to-do list is maintained in the git repository, and can
 be viewed at L<http://perl5.git.perl.org/perl.git/blob/HEAD:/Porting/todo.pod>

--------------1.8.1.2--



From d4ce392cb18b2a954ffef1eeb54f89e575131189 Mon Sep 17 00:00:00 2001
From: Smylers <Smylers@stripey.com>
Date: Thu, 5 Sep 2013 11:26:50 +0100
Subject: [PATCH 3/4] Add titles to deleted OO docs
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="------------1.8.1.2"

This is a multi-part message in MIME format.
--------------1.8.1.2
Content-Type: text/plain; charset=UTF-8; format=fixed
Content-Transfer-Encoding: 8bit


Helpful somebody who encounters these documents or their titles realize
they contain links to where current information can be found.

For RT #119615, based on Father Chrysostomos's comment in RT #119571.
---
 pod/perlboot.pod | 5 ++++-
 pod/perlbot.pod  | 5 ++++-
 pod/perltooc.pod | 5 ++++-
 pod/perltoot.pod | 5 ++++-
 4 files changed, 16 insertions(+), 4 deletions(-)


--------------1.8.1.2
Content-Type: text/x-patch; name="0003-Add-titles-to-deleted-OO-docs.patch"
Content-Transfer-Encoding: 8bit
Content-Disposition: attachment; filename="0003-Add-titles-to-deleted-OO-docs.patch"

diff --git a/pod/perlboot.pod b/pod/perlboot.pod
index 15b7117..8259998 100644
--- a/pod/perlboot.pod
+++ b/pod/perlboot.pod
@@ -2,11 +2,14 @@
 
 =head1 NAME
 
-perlboot - This document has been deleted
+perlboot - Links to information on object-oriented programming in Perl
 
 =head1 DESCRIPTION
 
 For information on OO programming with Perl, please see L<perlootut>
 and L<perlobj>.
 
+(The above documents supersede the tutorial that was formerly here in
+perlboot.)
+
 =cut
diff --git a/pod/perlbot.pod b/pod/perlbot.pod
index 2e8c680..cbf6649 100644
--- a/pod/perlbot.pod
+++ b/pod/perlbot.pod
@@ -2,11 +2,14 @@
 
 =head1 NAME
 
-perlbot - This document has been deleted
+perlbot - Links to information on object-oriented programming in Perl
 
 =head1 DESCRIPTION
 
 For information on OO programming with Perl, please see L<perlootut>
 and L<perlobj>.
 
+(The above documents supersede the collection of tricks that was formerly here
+in perlbot.)
+
 =cut
diff --git a/pod/perltooc.pod b/pod/perltooc.pod
index 3516325..b6a1764 100644
--- a/pod/perltooc.pod
+++ b/pod/perltooc.pod
@@ -2,11 +2,14 @@
 
 =head1 NAME
 
-perltooc - This document has been deleted
+perltooc - Links to information on object-oriented programming in Perl
 
 =head1 DESCRIPTION
 
 For information on OO programming with Perl, please see L<perlootut>
 and L<perlobj>.
 
+(The above documents supersede the tutorial that was formerly here in
+perltooc.)
+
 =cut
diff --git a/pod/perltoot.pod b/pod/perltoot.pod
index c896290..468dcae 100644
--- a/pod/perltoot.pod
+++ b/pod/perltoot.pod
@@ -2,11 +2,14 @@
 
 =head1 NAME
 
-perltoot - This document has been deleted
+perltoot - Links to information on object-oriented programming in Perl
 
 =head1 DESCRIPTION
 
 For information on OO programming with Perl, please see L<perlootut>
 and L<perlobj>.
 
+(The above documents supersede the tutorial that was formerly here in
+perltoot.)
+
 =cut

--------------1.8.1.2--



From f74f14d04b22f800c32d4b42c36940f5a68a4195 Mon Sep 17 00:00:00 2001
From: Smylers <Smylers@stripey.com>
Date: Thu, 5 Sep 2013 11:29:15 +0100
Subject: [PATCH 4/4] Make perltodo.pod match other deleted documents
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="------------1.8.1.2"

This is a multi-part message in MIME format.
--------------1.8.1.2
Content-Type: text/plain; charset=UTF-8; format=fixed
Content-Transfer-Encoding: 8bit


Have the title make clear it's now only a link to the to-do list.

Re-arrange the body content so the most useful thing — the link to the
current to-do list — is first and the history afterwards.

For RT #119615.
---
 pod/perltodo.pod | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)


--------------1.8.1.2
Content-Type: text/x-patch; name="0004-Make-perltodo.pod-match-other-deleted-documents.patch"
Content-Transfer-Encoding: 8bit
Content-Disposition: attachment; filename="0004-Make-perltodo.pod-match-other-deleted-documents.patch"

diff --git a/pod/perltodo.pod b/pod/perltodo.pod
index 20059ca..2011e1d 100644
--- a/pod/perltodo.pod
+++ b/pod/perltodo.pod
@@ -1,10 +1,11 @@
 =head1 NAME
 
-perltodo - Perl TO-DO List
+perltodo - Link to the Perl to-do list
 
 =head1 DESCRIPTION
 
-We no longer install the Perl 5 to-do list as a manpage, as installing a
-snapshot that becomes increasingly out of date isn't that useful to anyone.
-The current Perl 5 to-do list is maintained in the git repository, and can
+The Perl 5 to-do list is maintained in the git repository, and can
 be viewed at L<http://perl5.git.perl.org/perl.git/blob/HEAD:/Porting/todo.pod>
+
+(The to-do list used to be here in perltodo. That has stopped, as installing a
+snapshot that becomes increasingly out of date isn't that useful to anyone.)

--------------1.8.1.2--


@p5pRT
Copy link
Author

p5pRT commented Sep 5, 2013

From @cpansprout

On Thu Sep 05 03​:47​:49 2013, smylers@​stripey.com wrote​:

Patch attached. Also fixes a couple of other small matters relating to
deleted documents.

Thank you. Applied​:

$ git log --pretty=%h -4
1bd8383
7365d58
1046f92
9ab6383

--

Father Chrysostomos

@p5pRT
Copy link
Author

p5pRT commented Sep 5, 2013

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

@p5pRT
Copy link
Author

p5pRT commented Sep 5, 2013

@cpansprout - 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