Skip Menu |

This queue is for tickets about the Data-Stag CPAN distribution.

Report information
The Basics
Id: 37218
Status: open
Priority: 0/
Queue: Data-Stag
People
Owner: Nobody in particular
Requestors: plessy [...] debian.org
Cc:
AdminCc:
Bug Information
Severity: Wishlist
Broken in:
  • 0.10
  • 0.11
Fixed in: (no value)

History Show all quoted text
  Mon Jun 30 00:03:54 2008 plessy [...] debian.org - Ticket created
Subject: Missing manpages and WHATIS entries.
Hello, the following scripts do not have a POD manual page. In the package we distribute in Debian, our policy is to provide a manual page for all executables in /usr/bin, so we wrote minimal POD manpages for the following programs: stag-itext2simple.pl stag-itext2sxpr.pl stag-itext2xml.pl stag-xml2itext.pl They are available as a patch in our source package and on our public Subversion browser: http://svn.debian.org/wsvn/pkg-perl/trunk/libdata-stag-perl/debian/patches/missing-manpages.patch?op=file&rev=0&sc=0 Many of the manual pages that are already provided by the Data::Stag POD documentation miss WHATIS entries (the comment after the program name in the NAME section). As these entries are useful for indexing programs, we added them through the following patch: http://svn.debian.org/wsvn/pkg-perl/trunk/libdata-stag-perl/debian/patches/fix_WHATIS_entries.patch?op=file&rev=0&sc=0 Best regards, -- Charles Plessy Debian-Med packaging team Tsurumi, Kanagawa, Japan
  Tue Sep 17 15:58:09 2013 fschlich [...] zedat.fu-berlin.de - Correspondence added
From: fschlich [...] zedat.fu-berlin.de
On Mon Jun 30 00:03:54 2008, plessy wrote: Show quoted text
> http://svn.debian.org/wsvn/pkg-perl/trunk/libdata-stag- > perl/debian/patches/missing-manpages.patch?op=file&rev=0&sc=0
this URL is no longer valid; I'm attaching the patch current for Data::Stag 0.13 Show quoted text
> http://svn.debian.org/wsvn/pkg-perl/trunk/libdata-stag- > perl/debian/patches/fix_WHATIS_entries.patch?op=file&rev=0&sc=0
this patch has become obsolete, as the changes have been applied in 0.13. Thanks for that! NB: the POD for the commands in scripts/*, with the exception of scripts/stag-merge.pl, now references the commands without their .pl suffix. Would you be open to also remove the suffix on the script names themselves (ie, rename them)? Florian
Subject: missing-manpages.patch
Author: Charles Plessy <plessy@debian.org> Forwarded: http://rt.cpan.org/Public/Bug/Display.html?id=37218 Description: Adds POD documentation to supply missing manual pages. This patch is referenced in Debian bug #488614 License: Same as Data::Stag itself --- a/scripts/stag-itext2simple.pl +++ b/scripts/stag-itext2simple.pl @@ -12,3 +12,18 @@ foreach my $f (@ARGV) { $p->parse($f); } +__END__ + +=head1 NAME + +stag-itext2simple - converts between stag formats + +=head1 DESCRIPTION + +Converts from itext to simple format. + +=head1 SEE ALSO + +L<Data::Stag> + +=cut --- a/scripts/stag-itext2sxpr.pl +++ b/scripts/stag-itext2sxpr.pl @@ -11,4 +11,18 @@ foreach my $f (@ARGV) { } +__END__ +=head1 NAME + +stag-itext2sxpr - converts between stag formats + +=head1 DESCRIPTION + +Converts from itext to sxpr format. + +=head1 SEE ALSO + +L<Data::Stag> + +=cut --- a/scripts/stag-itext2xml.pl +++ b/scripts/stag-itext2xml.pl @@ -12,3 +12,19 @@ foreach my $f (@ARGV) { $p->parse($f); print $h->tree->xml; } + +__END__ + +=head1 NAME + +stag-itext2xml - converts between stag formats + +=head1 DESCRIPTION + +Converts from itext to xml format. + +=head1 SEE ALSO + +L<Data::Stag> + +=cut --- a/scripts/stag-xml2itext.pl +++ b/scripts/stag-xml2itext.pl @@ -9,4 +9,19 @@ $p->handler($h); foreach my $xmlfile (@ARGV) { $p->parse($xmlfile); } +__END__ + +=head1 NAME + +stag-xml2itext - converts between stag formats + +=head1 DESCRIPTION + +Converts from xml to itext format. + +=head1 SEE ALSO + +L<Data::Stag> + +=cut
  Tue Sep 17 15:58:10 2013 The RT System itself - Status changed from 'new' to 'open'
  Wed Sep 18 01:13:30 2013 CMUNGALL [...] cpan.org - Correspondence added
Will be in 0.14: https://github.com/cmungall/data-stag/commit/ac58b2fcca6758aebcfa613aee96313efe331ba4 On Mon Jun 30 00:03:54 2008, plessy wrote: Show quoted text
> Hello, > > the following scripts do not have a POD manual page. In the package we > distribute in Debian, our policy is to provide a manual page for all > executables in /usr/bin, so we wrote minimal POD manpages for the > following programs: > > stag-itext2simple.pl > stag-itext2sxpr.pl > stag-itext2xml.pl > stag-xml2itext.pl > > They are available as a patch in our source package and on our public > Subversion browser: > > http://svn.debian.org/wsvn/pkg-perl/trunk/libdata-stag- > perl/debian/patches/missing-manpages.patch?op=file&rev=0&sc=0 > > > Many of the manual pages that are already provided by the Data::Stag > POD > documentation miss WHATIS entries (the comment after the program name > in > the NAME section). As these entries are useful for indexing programs, > we > added them through the following patch: > > http://svn.debian.org/wsvn/pkg-perl/trunk/libdata-stag- > perl/debian/patches/fix_WHATIS_entries.patch?op=file&rev=0&sc=0 > > > Best regards,