Google Groups no longer supports new Usenet posts or subscriptions. Historical content remains viewable.
Dismiss

[perl #38229] [TODO] Make all pod documents(such as README's) end in .pod

1 view
Skip to first unread message

Joshua Isom

unread,
Jan 13, 2006, 5:59:44 PM1/13/06
to bugs-bi...@rt.perl.org
# New Ticket Created by Joshua Isom
# Please include the string: [perl #38229]
# in the subject line of all future correspondence about this issue.
# <URL: https://rt.perl.org/rt3/Ticket/Display.html?id=38229 >


There are a fair number of documentation files in parrot that are pod
files. Most of the README files aren't pod files, but the pge README
and the tcl README are. There are several other files where the same
occurs. If there aren't any objections, I can take care of this later
on. Running(under tcsh):

find -E . -not \( -name .svn -prune \) -type f -not -perm +111 -not
-regex '.*\.([a-z0-9_]+|C)' -not -name Makefile -not -name harness
-exec podchecker '{}' \; |& grep -v 'does not contain any pod commands'

seems to find them all(except README.win32) as best I can tell. It's
just a little annoying to me to expect a text file and get a pod file.

Joshua Hoblitt

unread,
Jan 14, 2006, 8:45:55 AM1/14/06
to perl6-i...@perl.org
On Fri, Jan 13, 2006 at 02:59:44PM -0800, Joshua Isom wrote:
>
> There are a fair number of documentation files in parrot that are pod
> files. Most of the README files aren't pod files, but the pge README
> and the tcl README are. There are several other files where the same
> occurs. If there aren't any objections, I can take care of this later
> on. Running(under tcsh):

I renamed all of the '.dev' docs to '.pod' a few days ago.

> find -E . -not \( -name .svn -prune \) -type f -not -perm +111 -not
> -regex '.*\.([a-z0-9_]+|C)' -not -name Makefile -not -name harness
> -exec podchecker '{}' \; |& grep -v 'does not contain any pod commands'

This should get everything:

perl -mPod::Find -mFile::Find::Rule -le 'print join "\n", grep !/\.(?:pm|pl|pod|t|pir|pasm|pmc|ops|pbc|dump|c|h)$/, File::Find::Rule->file->exec(sub {Pod::Find::contains_pod($_[0]) && not -x $_[0]} )->not_name(qw( harness .svn CVS))->in(".")'

Note: Pod::Parser prior to 1.34 (or maybe 1.33 - I can't remember when
I submitted the patch) will miss some valid pod files

> seems to find them all(except README.win32) as best I can tell. It's
> just a little annoying to me to expect a text file and get a pod file.

I agree. The obvious candidates are:

README.win32
compilers/pge/README
compilers/pge/P6Rule.grammar (-> P6Rule_grammar.pod?)
docs/BROKEN
docs/ROADMAP
tools/util/smokeserv-README
src/dynclasses/README
languages/LANGUAGES.STATUS
languages/tcl/README

I'm happy to make these changes if there are no objections.

Cheers,

-J

--

0 new messages