From: Stas Bekman Date: Mon, 8 Apr 2002 13:43:36 +0000 (+0800) Subject: docco fixes X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=9a68f1db1c7b0c0fefcb22b92221b9fd6871675b;p=p5sagit%2Fp5-mst-13.2.git docco fixes Message-Id: p4raw-id: //depot/perl@15799 --- diff --git a/pod/perlguts.pod b/pod/perlguts.pod index 59c9fb0..f9ebdae 100644 --- a/pod/perlguts.pod +++ b/pod/perlguts.pod @@ -599,10 +599,27 @@ be set, using the routines appropriate to the data type. There are additional macros whose values may be bitwise OR'ed with the C argument to enable certain extra features. Those bits are: - GV_ADDMULTI Marks the variable as multiply defined, thus preventing the - "Name used only once: possible typo" warning. - GV_ADDWARN Issues the warning "Had to create unexpectedly" if - the variable did not exist before the function was called. +=over + +=item GV_ADDMULTI + +Marks the variable as multiply defined, thus preventing the: + + Name used only once: possible typo + +warning. + +=over + +=item GV_ADDWARN + +Issues the warning: + + Had to create unexpectedly + +if the variable did not exist before the function was called. + +=back If you do not specify a package name, the variable is created in the current package. @@ -674,7 +691,7 @@ The first call creates a mortal SV (with no value), the second converts an exist SV to a mortal SV (and thus defers a call to C), and the third creates a mortal copy of an existing SV. Because C gives the new SV no value,it must normally be given one -via C, C etc. : +via C, C, etc. : SV *tmp = sv_newmortal(); sv_setiv(tmp, an_integer); @@ -1034,7 +1051,7 @@ you find yourself actually applying such information in this section, be aware that the behavior may change in the future, umm, without warning. The perl tie function associates a variable with an object that implements -the various GET, SET etc methods. To perform the equivalent of the perl +the various GET, SET, etc methods. To perform the equivalent of the perl tie function from an XSUB, you must mimic this behaviour. The code below carries out the necessary steps - firstly it creates a new hash, and then creates a second hash which it blesses into the class which will implement @@ -1128,7 +1145,7 @@ This construction is I equivalent to The biggest difference is that the first construction would reinstate the initial value of $var, irrespective of how control exits -the block: C, C, C/C etc. It is a little bit +the block: C, C, C/C, etc. It is a little bit more efficient as well. There is a way to achieve a similar task from C via Perl API: create a @@ -1342,7 +1359,7 @@ trapped, and how to treat return values. All four routines return the number of arguments that the subroutine returned on the Perl stack. -These routines used to be called C etc., before Perl v5.6.0, +These routines used to be called C, etc., before Perl v5.6.0, but those names are now deprecated; macros of the same name are provided for compatibility. @@ -1490,7 +1507,7 @@ the scratchpad AV. In fact it contains a pointer to an AV of (initially) one element, and this element is the scratchpad AV. Why do we need an extra level of indirection? -The answer is B, and maybe (sometime soon) B. Both +The answer is B, and maybe B. Both these can create several execution pointers going into the same subroutine. For the subroutine-child not write over the temporaries for the subroutine-parent (lifespan of which covers the call to the @@ -1731,7 +1748,7 @@ interpreters, with one interpreter represented either as a C structure, or inside a thread-specific structure. These structures contain all the context, the state of that interpreter. -Three macros control the major Perl build flavors: MULTIPLICITY, and +Two macros control the major Perl build flavors: MULTIPLICITY and USE_5005THREADS. The MULTIPLICITY build has a C structure that packages all the interpreter state, and there is a similar thread-specific data structure under USE_5005THREADS. In both cases, @@ -2342,7 +2359,7 @@ high character - C is one of those. =head1 Custom Operators -Custom operator support is a new experimental feature that allows you do +Custom operator support is a new experimental feature that allows you to define your own ops. This is primarily to allow the building of interpreters for other languages in the Perl core, but it also allows optimizations through the creation of "macro-ops" (ops which perform the