Change 14041 by jhi@alpha on 2002/01/03 15:57:42
Missed the =head1 additions.
Affected files ...
.... //depot/perl/XSUB.h#61 edit
.... //depot/perl/av.c#62 edit
.... //depot/perl/av.h#16 edit
.... //depot/perl/cop.h#61 edit
.... //depot/perl/cv.h#32 edit
.... //depot/perl/doio.c#186 edit
.... //depot/perl/gv.c#160 edit
.... //depot/perl/gv.h#22 edit
.... //depot/perl/handy.h#51 edit
.... //depot/perl/hv.h#27 edit
.... //depot/perl/intrpvar.h#97 edit
.... //depot/perl/mg.c#217 edit
.... //depot/perl/numeric.c#16 edit
.... //depot/perl/op.c#470 edit
.... //depot/perl/op.h#103 edit
.... //depot/perl/perl.c#404 edit
.... //depot/perl/pp.h#47 edit
.... //depot/perl/pp_sort.c#6 edit
.... //depot/perl/scope.h#50 edit
.... //depot/perl/sharedsv.c#15 edit
.... //depot/perl/sv.c#503 edit
.... //depot/perl/sv.h#105 edit
.... //depot/perl/thrdvar.h#51 edit
.... //depot/perl/universal.c#40 edit
.... //depot/perl/utf8.c#148 edit
.... //depot/perl/util.c#314 edit
Differences ...
==== //depot/perl/XSUB.h#61 (text) ====
Index: perl/XSUB.h
--- perl/XSUB.h.~1~ Thu Jan 3 09:15:05 2002
+++ perl/XSUB.h Thu Jan 3 09:15:05 2002
@@ -4,6 +4,8 @@
/* first, some documentation for xsubpp-generated items */
/*
+=head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
+
=for apidoc Amn|char*|CLASS
Variable which is setup by C<xsubpp> to indicate the
class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
@@ -98,6 +100,8 @@
/* Typically used to return values from XS functions. */
/*
+=head1 Stack Manipulation Macros
+
=for apidoc Am|void|XST_mIV|int pos|IV iv
Place an integer into the specified position C<pos> on the stack. The
value is stored in a new mortal SV.
@@ -147,6 +151,8 @@
=for apidoc Ams||XSRETURN_EMPTY
Return an empty list from an XSUB immediately.
+=head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
+
=for apidoc AmU||newXSproto
Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
the subs.
==== //depot/perl/av.c#62 (text) ====
Index: perl/av.c
--- perl/av.c.~1~ Thu Jan 3 09:15:05 2002
+++ perl/av.c Thu Jan 3 09:15:05 2002
@@ -12,6 +12,10 @@
* meant that things should remain where they had set them)." --Treebeard
*/
+/*
+=head1 Array Manipulation Functions
+*/
+
#include "EXTERN.h"
#define PERL_IN_AV_C
#include "perl.h"
==== //depot/perl/av.h#16 (text) ====
Index: perl/av.h
--- perl/av.h.~1~ Thu Jan 3 09:15:05 2002
+++ perl/av.h Thu Jan 3 09:15:05 2002
@@ -46,9 +46,13 @@
#define AVf_REUSED 4 /* got undeffed--don't turn old memory into SVs now */
/*
+=head1 Handy Values
+
=for apidoc AmU||Nullav
Null AV pointer.
+=head1 Array Manipulation Functions
+
=for apidoc Am|int|AvFILL|AV* av
Same as C<av_len()>. Deprecated, use C<av_len()> instead.
==== //depot/perl/cop.h#61 (text) ====
Index: perl/cop.h
--- perl/cop.h.~1~ Thu Jan 3 09:15:05 2002
+++ perl/cop.h Thu Jan 3 09:15:05 2002
@@ -388,7 +388,9 @@
#define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
-/* "gimme" values */
+/*
+=head1 "Gimme" Values
+*/
/*
=for apidoc AmU||G_SCALAR
==== //depot/perl/cv.h#32 (text) ====
Index: perl/cv.h
--- perl/cv.h.~1~ Thu Jan 3 09:15:05 2002
+++ perl/cv.h Thu Jan 3 09:15:05 2002
@@ -37,9 +37,13 @@
};
/*
+=head1 Handy Values
+
=for apidoc AmU||Nullcv
Null CV pointer.
+=head1 CV Manipulation Functions
+
=for apidoc Am|HV*|CvSTASH|CV* cv
Returns the stash of the CV.
==== //depot/perl/doio.c#186 (text) ====
Index: perl/doio.c
--- perl/doio.c.~1~ Thu Jan 3 09:15:05 2002
+++ perl/doio.c Thu Jan 3 09:15:05 2002
@@ -2106,6 +2106,8 @@
#endif /* SYSV IPC */
/*
+=head1 IO Functions
+
=for apidoc start_glob
Function called by C<do_readline> to spawn a glob (or do the glob inside
==== //depot/perl/gv.c#160 (text) ====
Index: perl/gv.c
--- perl/gv.c.~1~ Thu Jan 3 09:15:05 2002
+++ perl/gv.c Thu Jan 3 09:15:05 2002
@@ -16,6 +16,10 @@
* laughed Pippin.
*/
+/*
+=head1 GV Functions
+*/
+
#include "EXTERN.h"
#define PERL_IN_GV_C
#include "perl.h"
==== //depot/perl/gv.h#22 (text) ====
Index: perl/gv.h
--- perl/gv.h.~1~ Thu Jan 3 09:15:05 2002
+++ perl/gv.h Thu Jan 3 09:15:05 2002
@@ -35,6 +35,8 @@
#define GvFLAGS(gv) (GvXPVGV(gv)->xgv_flags)
/*
+=head1 GV Functions
+
=for apidoc Am|SV*|GvSV|GV* gv
Return the SV from the GV.
==== //depot/perl/handy.h#51 (text) ====
Index: perl/handy.h
--- perl/handy.h.~1~ Thu Jan 3 09:15:05 2002
+++ perl/handy.h Thu Jan 3 09:15:05 2002
@@ -21,9 +21,10 @@
#define Null(type) ((type)NULL)
/*
-=for apidoc AmU||Nullch
+=head1 Handy Values
+
+=for apidoc AmU||Nullch
Null character pointer.
-
=for apidoc AmU||Nullsv
Null SV pointer.
@@ -210,6 +211,8 @@
#define Ctl(ch) ((ch) & 037)
/*
+=head1 Miscellaneous Functions
+
=for apidoc Am|bool|strNE|char* s1|char* s2
Test two strings to see if they are different. Returns true or
false.
@@ -283,6 +286,9 @@
#endif
/*
+
+=head1 Character classes
+
=for apidoc Am|bool|isALNUM|char ch
Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
character (including underscore) or digit.
@@ -515,6 +521,8 @@
*/
/*
+=head1 SV Manipulation Functions
+
=for apidoc Am|SV*|NEWSV|int id|STRLEN len
Creates a new SV. A non-zero C<len> parameter indicates the number of
bytes of preallocated string space the SV should have. An extra byte for a
@@ -522,6 +530,8 @@
space is allocated.) The reference count for the new SV is set to 1.
C<id> is an integer id between 0 and 1299 (used to identify leaks).
+=head1 Memory Management
+
=for apidoc Am|void|New|int id|void* ptr|int nitems|type
The XSUB-writer's interface to the C C<malloc> function.
==== //depot/perl/hv.h#27 (text) ====
Index: perl/hv.h
--- perl/hv.h.~1~ Thu Jan 3 09:15:05 2002
+++ perl/hv.h Thu Jan 3 09:15:05 2002
@@ -63,14 +63,20 @@
} STMT_END
/*
+=head1 Hash Manipulation Functions
+
=for apidoc AmU||HEf_SVKEY
This flag, used in the length slot of hash entries and magic structures,
specifies the structure contains an C<SV*> pointer where a C<char*> pointer
is to be expected. (For information only--not to be used).
+=head1 Handy Values
+
=for apidoc AmU||Nullhv
Null HV pointer.
+=head1 Hash Manipulation Functions
+
=for apidoc Am|char*|HvNAME|HV* stash
Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
==== //depot/perl/intrpvar.h#97 (text) ====
Index: perl/intrpvar.h
--- perl/intrpvar.h.~1~ Thu Jan 3 09:15:05 2002
+++ perl/intrpvar.h Thu Jan 3 09:15:05 2002
@@ -38,6 +38,8 @@
PERLVAR(Idoswitches, bool)
/*
+=head1 Global Variables
+
=for apidoc mn|bool|PL_dowarn
The C variable which corresponds to Perl's $^W warning variable.
==== //depot/perl/mg.c#217 (text) ====
Index: perl/mg.c
--- perl/mg.c.~1~ Thu Jan 3 09:15:05 2002
+++ perl/mg.c Thu Jan 3 09:15:05 2002
@@ -12,6 +12,10 @@
* come here, and I don't want to see no more magic,' he said, and fell silent."
*/
+/*
+=head1 Magical Functions
+*/
+
#include "EXTERN.h"
#define PERL_IN_MG_C
#include "perl.h"
==== //depot/perl/numeric.c#16 (text) ====
Index: perl/numeric.c
--- perl/numeric.c.~1~ Thu Jan 3 09:15:05 2002
+++ perl/numeric.c Thu Jan 3 09:15:05 2002
@@ -12,6 +12,10 @@
* wizards count differently to other people."
*/
+/*
+=head1 Numeric functions
+*/
+
#include "EXTERN.h"
#define PERL_IN_NUMERIC_C
#include "perl.h"
==== //depot/perl/op.c#470 (text) ====
Index: perl/op.c
--- perl/op.c.~1~ Thu Jan 3 09:15:05 2002
+++ perl/op.c Thu Jan 3 09:15:05 2002
@@ -15,6 +15,7 @@
* either way, as the saying is, if you follow me." --the Gaffer
*/
+
#include "EXTERN.h"
#define PERL_IN_OP_C
#include "perl.h"
@@ -3453,6 +3454,8 @@
}
/*
+=head1 Embedding Functions
+
=for apidoc load_module
Loads the module whose name is pointed to by the string part of name.
@@ -4632,6 +4635,9 @@
static void const_sv_xsub(pTHX_ CV* cv);
/*
+
+=head1 Optree Manipulation Functions
+
=for apidoc cv_const_sv
If C<cv> is a constant sub eligible for inlining. returns the constant
==== //depot/perl/op.h#103 (text) ====
Index: perl/op.h
--- perl/op.h.~1~ Thu Jan 3 09:15:05 2002
+++ perl/op.h Thu Jan 3 09:15:05 2002
@@ -59,6 +59,8 @@
dfl)
/*
+=head1 "Gimme" Values
+
=for apidoc Amn|U32|GIMME_V
The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
==== //depot/perl/perl.c#404 (text) ====
Index: perl/perl.c
--- perl/perl.c.~1~ Thu Jan 3 09:15:05 2002
+++ perl/perl.c Thu Jan 3 09:15:05 2002
@@ -102,6 +102,8 @@
#else
/*
+=head1 Embedding Functions
+
=for apidoc perl_alloc
Allocates a new Perl interpreter. See L<perlembed>.
@@ -1622,6 +1624,8 @@
}
/*
+=head1 SV Manipulation Functions
+
=for apidoc p||get_sv
Returns the SV of the specified Perl scalar. If C<create> is set and the
@@ -1649,6 +1653,8 @@
}
/*
+=head1 Array Manipulation Functions
+
=for apidoc p||get_av
Returns the AV of the specified Perl array. If C<create> is set and the
@@ -1670,6 +1676,8 @@
}
/*
+=head1 Hash Manipulation Functions
+
=for apidoc p||get_hv
Returns the HV of the specified Perl hash. If C<create> is set and the
@@ -1691,6 +1699,8 @@
}
/*
+=head1 CV Manipulation Functions
+
=for apidoc p||get_cv
Returns the CV of the specified Perl subroutine. If C<create> is set and
@@ -1722,6 +1732,9 @@
/* Be sure to refetch the stack pointer after calling these routines. */
/*
+
+=head1 Callback Functions
+
=for apidoc p||call_argv
Performs a callback to the specified Perl sub. See L<perlcall>.
@@ -2103,6 +2116,8 @@
/* Require a module. */
/*
+=head1 Embedding Functions
+
=for apidoc p||require_pv
Tells Perl to C<require> the file named by the string argument. It is
==== //depot/perl/pp.h#47 (text) ====
Index: perl/pp.h
--- perl/pp.h.~1~ Thu Jan 3 09:15:05 2002
+++ perl/pp.h Thu Jan 3 09:15:05 2002
@@ -18,6 +18,8 @@
#define PP(s) OP * Perl_##s(pTHX)
/*
+=head1 Stack Manipulation Macros
+
=for apidoc AmU||SP
Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
C<SPAGAIN>.
==== //depot/perl/pp_sort.c#6 (text) ====
Index: perl/pp_sort.c
--- perl/pp_sort.c.~1~ Thu Jan 3 09:15:05 2002
+++ perl/pp_sort.c Thu Jan 3 09:15:05 2002
@@ -1368,6 +1368,8 @@
}
/*
+=head1 Array Manipulation Functions
+
=for apidoc sortsv
Sort an array. Here is an example:
==== //depot/perl/scope.h#50 (text) ====
Index: perl/scope.h
--- perl/scope.h.~1~ Thu Jan 3 09:15:05 2002
+++ perl/scope.h Thu Jan 3 09:15:05 2002
@@ -55,6 +55,8 @@
#define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
/*
+=head1 Callback Functions
+
=for apidoc Ams||SAVETMPS
Opening bracket for temporaries on a callback. See C<FREETMPS> and
L<perlcall>.
==== //depot/perl/sharedsv.c#15 (text) ====
Index: perl/sharedsv.c
--- perl/sharedsv.c.~1~ Thu Jan 3 09:15:05 2002
+++ perl/sharedsv.c Thu Jan 3 09:15:05 2002
@@ -33,6 +33,8 @@
*/
/*
+=head1 Shared SV Functions
+
=for apidoc sharedsv_init
Saves a space for keeping SVs wider than an interpreter,
==== //depot/perl/sv.c#503 (text) ====
Index: perl/sv.c
--- perl/sv.c.~1~ Thu Jan 3 09:15:05 2002
+++ perl/sv.c Thu Jan 3 09:15:05 2002
@@ -216,6 +216,8 @@
/*
+=head1 SV Manipulation Functions
+
=for apidoc sv_add_arena
Given a chunk of memory, link it to the head of the list of arenas,
@@ -10386,6 +10388,8 @@
#endif /* USE_ITHREADS */
/*
+=head1 Unicode Support
+
=for apidoc sv_recode_to_utf8
The encoding is assumed to be an Encode object, on entry the PV
==== //depot/perl/sv.h#105 (text) ====
Index: perl/sv.h
--- perl/sv.h.~1~ Thu Jan 3 09:15:05 2002
+++ perl/sv.h Thu Jan 3 09:15:05 2002
@@ -12,6 +12,8 @@
#endif
/*
+=head1 SV Flags
+
=for apidoc AmU||svtype
An enum of flags for Perl types. These are found in the file B<sv.h>
in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
@@ -98,6 +100,8 @@
};
/*
+=head1 SV Manipulation Functions
+
=for apidoc Am|U32|SvREFCNT|SV* sv
Returns the value of the object's reference count.
@@ -1139,6 +1143,8 @@
/* the following macros update any magic values this sv is associated with */
/*
+=head1 Magical Functions
+
=for apidoc Am|void|SvGETMAGIC|SV* sv
Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
argument more than once.
@@ -1161,6 +1167,8 @@
=for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
Like C<SvSetMagicSV>, but does any set magic required afterwards.
+=head1 SV Manipulation Functions
+
=for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
Expands the character buffer in the SV so that it has room for the
indicated number of bytes (remember to reserve space for an extra trailing
==== //depot/perl/thrdvar.h#51 (text) ====
Index: perl/thrdvar.h
--- perl/thrdvar.h.~1~ Thu Jan 3 09:15:05 2002
+++ perl/thrdvar.h Thu Jan 3 09:15:05 2002
@@ -1,3 +1,7 @@
+/*
+=head1 Global Variables
+*/
+
/***********************************************/
/* Global only to current thread */
/***********************************************/
==== //depot/perl/universal.c#40 (text) ====
Index: perl/universal.c
--- perl/universal.c.~1~ Thu Jan 3 09:15:05 2002
+++ perl/universal.c Thu Jan 3 09:15:05 2002
@@ -93,6 +93,8 @@
}
/*
+=head1 SV Manipulation Functions
+
=for apidoc sv_derived_from
Returns a boolean indicating whether the SV is derived from the specified
==== //depot/perl/utf8.c#148 (text) ====
Index: perl/utf8.c
--- perl/utf8.c.~1~ Thu Jan 3 09:15:05 2002
+++ perl/utf8.c Thu Jan 3 09:15:05 2002
@@ -24,9 +24,9 @@
#define PERL_IN_UTF8_C
#include "perl.h"
-/* Unicode support */
+/*
+=head1 Unicode Support
-/*
=for apidoc A|U8 *|uvuni_to_utf8_flags|U8 *d|UV uv|UV flags
Adds the UTF8 representation of the Unicode codepoint C<uv> to the end
==== //depot/perl/util.c#314 (text) ====
Index: perl/util.c
--- perl/util.c.~1~ Thu Jan 3 09:15:05 2002
+++ perl/util.c Thu Jan 3 09:15:05 2002
@@ -488,6 +488,8 @@
If FBMcf_TAIL, the table is created as if the string has a trailing \n. */
/*
+=head1 Miscellaneous Functions
+
=for apidoc fbm_compile
Analyses the string in order to make fast searches on it using fbm_instr()
@@ -877,6 +879,8 @@
/* copy a string to a safe spot */
/*
+=head1 Memory Management
+
=for apidoc savepv
Copy a string to a safe spot. This does not use an SV.
@@ -955,6 +959,7 @@
#endif /* PERL_IMPLICIT_CONTEXT */
/*
+=head1 Miscellaneous Functions
=for apidoc form
Takes a sprintf-style format pattern and conventional
@@ -1285,6 +1290,8 @@
#endif /* PERL_IMPLICIT_CONTEXT */
/*
+=head1 Warning and Dieing
+
=for apidoc croak
This is the XSUB-writer's interface to Perl's C<die> function.
@@ -3759,6 +3766,8 @@
(dp->d_name[1] == '.' && dp->d_name[2] == '\0')))
/*
+=head1 Miscellaneous Functions
+
=for apidoc getcwd_sv
Fill the sv with current working directory
@@ -3921,6 +3930,8 @@
}
/*
+=head1 SV Manipulation Functions
+
=for apidoc new_vstring
Returns a pointer to the next character after the parsed
End of Patch.
