In perl.git, the branch smoke-me/Pod-Functions has been created
<http://perl5.git.perl.org/perl.git/commitdiff/60ded7e2df9a20f0f6bbb995fc652fcd5940108f?hp=0000000000000000000000000000000000000000>
at 60ded7e2df9a20f0f6bbb995fc652fcd5940108f (commit)
- Log -----------------------------------------------------------------
commit 60ded7e2df9a20f0f6bbb995fc652fcd5940108f
Author: Nicholas Clark <[email protected]>
Date: Mon Jan 30 20:05:33 2012 +0100
Test that functions in the groups in perlfunc.pod are in sorted order.
This ensures consistency in the documentation, and that the functions in
%Pod::Functions::Kinds are in sorted order.
M ext/Pod-Functions/Functions_pm.PL
commit c55969020e853f54eb52c41d878d9ae62f6313c9
Author: Nicholas Clark <[email protected]>
Date: Mon Jan 30 18:41:54 2012 +0100
Test that every function in perlfunc.pod has a summary for Pod::Functions.
Historically Pod::Functions has failed to get updated when functions are
added. This should solve that.
M ext/Pod-Functions/Functions_pm.PL
M t/porting/perlfunc.t
commit 1dc1356af7ff438899bdaf55201ae98a6006ee4d
Author: Nicholas Clark <[email protected]>
Date: Mon Jan 30 14:47:13 2012 +0100
Add t/porting/perlfunc.t so that porting tests catch problems with perlfunc
Pod::Functions is now generated from pod/perlfunc.pod by
ext/Pod-Functions/Functions_pm.PL
If it can't parse pod/perlfunc.pod, it will abort, which will cause the
build to break. It's really not possible for it to carry on, hence aborting
is the only option. However, innocent-seeming changes to documentation
shouldn't break the build, and we expect everyone to run (at least)
the porting tests, hence this test, to catch such problems before it's too
late. To avoid duplicating the parsing logic, we make Functions_pm.PL take
a --tap option, to test that all is well.
M MANIFEST
M ext/Pod-Functions/Functions_pm.PL
M pod/perldelta.pod
A t/porting/perlfunc.t
commit 3571edba3dafa97099631d7c52faa992a4756152
Author: Nicholas Clark <[email protected]>
Date: Mon Jan 30 12:27:40 2012 +0100
In the generated Pod::Functions, store all function data with tab
separation.
Previously the data was stored with a comma separated list inside a tab
separated list.
M ext/Pod-Functions/Functions_pm.PL
commit 9e4688737dac76f54a8bfb349a9cd813d59c436a
Author: Nicholas Clark <[email protected]>
Date: Mon Jan 30 12:15:36 2012 +0100
Generate Pod::Functions from perlfunc.pod
This avoids it getting out of synchronisation.
M ext/Pod-Functions/Functions_pm.PL
commit a21e75695294011350d50af78fd09d7f52a0d098
Author: Nicholas Clark <[email protected]>
Date: Mon Jan 30 12:01:08 2012 +0100
Add a dependency for ext/Pod-Functions/Functions_pm.PL on pod/perlfunc.pod
This ensures that it gets re-run, and lib/Pod/Functions.pm rebuilt, if
perlfunc.pod is changed.
M Makefile.SH
M ext/Pod-Functions/Makefile.PL
M vms/descrip_mms.template
M win32/Makefile
M win32/makefile.mk
commit 71c0e382a87ae21b1d6a509317453f2051c19c62
Author: Nicholas Clark <[email protected]>
Date: Mon Jan 30 11:41:13 2012 +0100
Ensure Pod::Simple is built before Pod::Functions.
This will allow Pod::Functions to use Pod::Simple as part of its build
process.
M Makefile.SH
M make_ext.pl
commit 14fff26d7c497c94213a29a724b986766c8bd35d
Author: Nicholas Clark <[email protected]>
Date: Sun Jan 29 17:21:27 2012 +0000
Change ext/Pod-Functions to generate Functions.pm from a Perl script.
For the first step, simply output the current file in one hit.
M MANIFEST
D ext/Pod-Functions/Functions.pm
A ext/Pod-Functions/Functions_pm.PL
A ext/Pod-Functions/Makefile.PL
commit 0fce5b15bcf7589a17251feb9360e2e6cd38444d
Author: Nicholas Clark <[email protected]>
Date: Sun Jan 29 14:56:01 2012 +0000
Add annotations to perlfunc.pod for Pod::Functions.
In the list for "Perl Functions by Category" each item is annotated with its
type as used internally by Pod::Functions.
In the "Alphabetical Listing of Perl Functions" each function is annotated
with the summary description returned by %Pod::Functions::Flavor.
M pod/perlfunc.pod
commit e9e293bcd0c0b70be22ed5eac9e775ca16eb7052
Author: Nicholas Clark <[email protected]>
Date: Sun Jan 29 13:00:41 2012 +0000
Move Pod::Functions from lib/ to ext/
M MANIFEST
M Porting/Maintainers.pl
A ext/Pod-Functions/Functions.pm
A ext/Pod-Functions/t/Functions.t
M lib/.gitignore
D lib/Pod/Functions.pm
D lib/Pod/t/Functions.t
commit a2ff2537c26fa95fb2edd75ad049412441368237
Author: Nicholas Clark <[email protected]>
Date: Sun Jan 29 12:23:31 2012 +0000
Bring the joy of strict and warnings to Functions.t
This reveals that use_ok() was not in a BEGIN block, and in turn that the
test count needs to be declared before this BEGIN block runs. Now fixed.
M lib/Pod/t/Functions.t
commit 55cb21e6080ada3e80d08c152b58ae4f7484a4b1
Author: Nicholas Clark <[email protected]>
Date: Sun Jan 29 12:06:05 2012 +0000
Terser code in Pod::Functions to generate $Type_Description and @Type_Order.
M lib/Pod/Functions.pm
commit 74eca3b26e3a4eb4f1a6b836c076f73cac9c5e86
Author: Nicholas Clark <[email protected]>
Date: Mon Jan 23 23:38:43 2012 +0100
Teach Pod::Functions that each, keys and values also operate on arrays.
These were added to the section 'Functions for real @ARRAYs' in perlfunc.pod
by commit a5ce339cb0c533c9 in Sep 2010.
As ever, tweak the golden results in the test to match these changes.
M lib/Pod/Functions.pm
M lib/Pod/t/Functions.t
commit 8283445b7422471dd37d5508305a7349ca094e59
Author: Nicholas Clark <[email protected]>
Date: Mon Jan 23 23:16:56 2012 +0100
Add all missing functions to Pod::Functions.
evalbytes was added to perlfunc.pod by commit 7289c5e6ca773d7c in Nov 2011.
fc was added to perlfunc.pod by commit 628253b8ba8b9cbe in Jan 2012.
say was added by commit 0d863452f5cac863 in Dec 2005.
state was added.pod by commit 36fb85f3330d45ee in Jul 2006.
__FILE__, __LINE__ and __PACKAGE__ were added by commit cfa52385fa426b5e in
Aug 2011, and __SUB__ by commit 84ed01088568ffe9 in Nov 2011.
Again, tweak the golden results in the test to match these changes.
M lib/Pod/Functions.pm
M lib/Pod/t/Functions.t
commit 51e19fdb44500953561ac488a282b4044b27ed96
Author: Nicholas Clark <[email protected]>
Date: Mon Jan 23 22:44:52 2012 +0100
Teach Pod::Functions about 'Keywords related to the switch feature'.
Commit 0d863452f5cac863 in Dec 2005 added the switch feature, along with
documentation in perlfunc.pod, but did not update Pod::Functions.
Again, tweak the golden results in the test to match these changes.
M lib/Pod/Functions.pm
M lib/Pod/t/Functions.t
commit 740318a391a86af783ccbde65ff732132ba0b579
Author: Nicholas Clark <[email protected]>
Date: Mon Jan 23 21:47:16 2012 +0100
Update Pod::Functions with changes from perlfunc.pod
Updated description of Binary from commit 5dac7880bdc47787 in Feb 2011.
Updated description of Flow from commit cf2649810f00335b in Jul 2005, and
added the "the" which has always been missing from Pod::Function's version.
Updated description of Modules from commit 3b10bc60979cfe9a in Jan 2010.
Updated description of Objects from commit 353c650532037e40 in Oct 2007.
The description of Namespaces had always differed from that in perlfunc.pod.
Remove stray tabs from the descriptions of gets and sprintf.
Commit 19799a22062ef658 (May 1999) added lock to perlfunc.pod without a
it is the only function in "Threads", move it to "Misc", instead of creating
a category just for it.
use always had two entries with different descriptions in the __DATA__
section. This isn't actually sensible, as the code that builds the exported
data structures ends up taking Types from both, and using the last
description that it sees. So merge the two together to reflect this.
Drop the CHANGES section from the Pod, which is both incomplete and
redundant, given that version control does this job much better.
Tweak the golden results in the test to match these changes.
M lib/Pod/Functions.pm
M lib/Pod/t/Functions.t
commit b64cd0f7cb630027c13f3810c55c500f6833ac5e
Author: Nicholas Clark <[email protected]>
Date: Mon Jan 23 17:51:48 2012 +0100
In perlfunc.pod, sort the descriptions more consistently.
The order is neither strictly lexical, nor strictly dictionary, but now for
all cases __FOO__ follows foo, and qx// is after qw//.
In the "Regular expressions and pattern matching" summary, put qr// in the
correct position alphabetically.
M pod/perlfunc.pod
commit 352cb86c1387e5f601ee31e6aeb0b5f47290960c
Author: Nicholas Clark <[email protected]>
Date: Mon Jan 23 17:32:17 2012 +0100
Add 4 functions missing from perlfunc.pod's 'Perl Functions by Category'.
C<readline> added to 'Input and output functions'
Documentation on readline was added by commit 8490252049bf42d3 in Aug 1997.
That commit also added readpipe without adding it to a category group, an
omission that was fixed by commit 4319b00c03e6a517 in Nov 2011.
C<sysseek> added to 'Functions for fixed-length data or records'
Documentation on sysseek was added by commit 137443ea0a858c43 in Apr 1997,
which implemented sysseek.
C<prototype> added to both 'Keywords related to the control flow of your
Perl
program' and 'Miscellaneous functions', as Pod::Functions places it in both.
Commit da0045b73af6f504 in Jul 1996, included 'Add documentation for new
"prototype" operator', but only added the main documentation, not an entry
in a category group.
C<lock> added to 'Miscellaneous functions'.
Documentation on lock was added by commit 19799a22062ef658 in May 1999.
M pod/perlfunc.pod
-----------------------------------------------------------------------
--
Perl5 Master Repository
