summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicholas Clark <nick@ccl4.org>2012-01-23 21:47:16 +0100
committerNicholas Clark <nick@ccl4.org>2012-02-18 13:16:51 +0100
commit3017d6ff27eb1c05142eea0fd45b5a74d2018e1a (patch)
treebfb884b2f4513bdd02c88a840fdf62fafa461722
parentf5fa2679be08eedfc24ad5bb18929e804aa6f8d1 (diff)
downloadperl-3017d6ff27eb1c05142eea0fd45b5a74d2018e1a.tar.gz
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.
-rw-r--r--lib/Pod/Functions.pm34
-rw-r--r--lib/Pod/t/Functions.t14
2 files changed, 17 insertions, 31 deletions
diff --git a/lib/Pod/Functions.pm b/lib/Pod/Functions.pm
index 5181c3990b..1227f56313 100644
--- a/lib/Pod/Functions.pm
+++ b/lib/Pod/Functions.pm
@@ -52,22 +52,9 @@ L<perlfunc/"Perl Functions by Category"> section.
=back
-=head1 CHANGES
-
-1.02 20020813 <abe@ztreet.demon.nl>
- de-typo in the SYNOPSIS section (thanks Mike Castle for noticing)
-
-1.01 20011229 <abe@ztreet.demon.nl>
- fixed some bugs that slipped in after 5.6.1
- added the pod
- finished making it strict safe
-
-1.00 ??
- first numbered version
-
=cut
-our $VERSION = '1.04';
+our $VERSION = '1.05';
require Exporter;
@@ -78,17 +65,17 @@ our(%Kinds, %Type, %Flavor);
our %Type_Description = (
'ARRAY' => 'Functions for real @ARRAYs',
- 'Binary' => 'Functions for fixed length data or records',
+ 'Binary' => 'Functions for fixed-length data or records',
'File' => 'Functions for filehandles, files, or directories',
- 'Flow' => 'Keywords related to control flow of your perl program',
+ 'Flow' => 'Keywords related to the control flow of your Perl program',
'HASH' => 'Functions for real %HASHes',
'I/O' => 'Input and output functions',
'LIST' => 'Functions for list data',
'Math' => 'Numeric functions',
'Misc' => 'Miscellaneous functions',
- 'Modules' => 'Keywords related to perl modules',
+ 'Modules' => 'Keywords related to Perl modules',
'Network' => 'Fetching network info',
- 'Objects' => 'Keywords related to classes and object-orientedness',
+ 'Objects' => 'Keywords related to classes and object-orientation',
'Process' => 'Functions for processes and process groups',
'Regexp' => 'Regular expressions and pattern matching',
'Socket' => 'Low-level socket functions',
@@ -96,7 +83,7 @@ our %Type_Description = (
'SysV' => 'System V interprocess communication functions',
'Time' => 'Time-related functions',
'User' => 'Fetching user and group info',
- 'Namespace' => 'Keywords altering or affecting scoping of identifiers',
+ 'Namespace' => 'Keywords related to scoping',
);
our @Type_Order = qw{
@@ -206,7 +193,7 @@ flock I/O lock an entire file with an advisory lock
fork Process create a new process just like this one
format I/O declare a picture format with use by the write() function
formline Misc internal function used for formats
-getc I/O get the next character from the filehandle
+getc I/O get the next character from the filehandle
getgrent User get next group record
getgrgid User get group record given group user ID
getgrnam User get group record given group name
@@ -252,7 +239,7 @@ link File create a hard link in the filesystem
listen Socket register your socket as a server
local Misc,Namespace create a temporary value for a global variable (dynamic scoping)
localtime Time convert UNIX time into record or string using local time
-lock Threads get a thread lock on a variable, subroutine, or method
+lock Misc get a thread lock on a variable, subroutine, or method
log Math retrieve the natural logarithm for a number
lstat File stat a symbolic link
m// Regexp match a string with a regular expression pattern
@@ -333,7 +320,7 @@ socketpair Socket create a pair of sockets
sort LIST sort a list of values
splice ARRAY add or remove elements anywhere in an array
split Regexp split up a string using a regexp delimiter
-sprintf String formatted print into a string
+sprintf String formatted print into a string
sqrt Math square root function
srand Math seed the random number generator
stat File get a file's status information
@@ -363,8 +350,7 @@ unlink File remove one link to a file
unpack Binary,LIST convert binary structure into normal perl variables
unshift ARRAY prepend more elements to the beginning of a list
untie Objects break a tie binding to a variable
-use Modules,Namespace load a module and import its namespace
-use Objects load in a module at compile time
+use Objects,Modules,Namespace load in a module at compile time and import its namespace
utime File set a file's last access and modify times
values HASH return a list of the values in a hash
vec Binary test or set particular bits in a string
diff --git a/lib/Pod/t/Functions.t b/lib/Pod/t/Functions.t
index 8f44d81201..30f270de73 100644
--- a/lib/Pod/t/Functions.t
+++ b/lib/Pod/t/Functions.t
@@ -102,7 +102,7 @@ Input and output functions:
sysread, sysseek, syswrite, tell, telldir, truncate, warn,
write
-Functions for fixed length data or records:
+Functions for fixed-length data or records:
pack, read, syscall, sysread, sysseek, syswrite, unpack,
vec
@@ -111,26 +111,26 @@ Functions for filehandles, files, or directories:
lstat, mkdir, open, opendir, readlink, rename, rmdir,
stat, symlink, sysopen, umask, unlink, utime
-Keywords related to control flow of your perl program:
+Keywords related to the control flow of your Perl program:
caller, continue, die, do, dump, eval, exit, goto, last,
next, prototype, redo, return, sub, wantarray
-Keywords altering or affecting scoping of identifiers:
+Keywords related to scoping:
caller, import, local, my, our, package, use
Miscellaneous functions:
- defined, dump, eval, formline, local, my, our, prototype,
- reset, scalar, undef, wantarray
+ defined, dump, eval, formline, local, lock, my, our,
+ prototype, reset, scalar, undef, wantarray
Functions for processes and process groups:
alarm, exec, fork, getpgrp, getppid, getpriority, kill,
pipe, qx/STRING/, readpipe, setpgrp, setpriority, sleep,
system, times, wait, waitpid
-Keywords related to perl modules:
+Keywords related to Perl modules:
do, import, no, package, require, use
-Keywords related to classes and object-orientedness:
+Keywords related to classes and object-orientation:
bless, dbmclose, dbmopen, package, ref, tie, tied, untie,
use