WS Cleanup Stage #10 - reformat comments using Text::Autoformat

Author: demerphq

XSUB.h

@@ -16,97 +16,97 @@
 /*
 =for apidoc_section $XS
 
-F<xsubpp> compiles XS code into C.  See L<perlutil/xsubpp>.
+F<xsubpp> compiles XS code into C. See L<perlutil/xsubpp>.
 
 =for comment
 Some variables below are flagged with 'u' because Devel::PPPort can't currently
 readily test them as they spring into existence by compiling with xsubpp.
 
 =for apidoc Amnu|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<L</THIS>>.
+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<L</THIS>>.
 
 =for apidoc Amnu|type|RETVAL
-Variable which is setup by C<xsubpp> to hold the return value for an
-XSUB.  This is always the proper type for the XSUB.  See
-L<perlxs/"The RETVAL Variable">.
+Variable which is setup by C<xsubpp> to hold the return value for an XSUB. This
+is always the proper type for the XSUB. See L<perlxs/"The RETVAL Variable">.
 
 =for apidoc Amnu|type|THIS
-Variable which is setup by C<xsubpp> to designate the object in a C++
-XSUB.  This is always the proper type for the C++ object.  See C<L</CLASS>> and
+Variable which is setup by C<xsubpp> to designate the object in a C++ XSUB.
+This is always the proper type for the C++ object. See C<L</CLASS>> and
 L<perlxs/"Using XS With C++">.
 
 =for apidoc Amn|I32|ax
-Variable which is setup by C<xsubpp> to indicate the stack base offset,
-used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros.  The C<dMARK> macro
-must be called prior to setup the C<MARK> variable.
+Variable which is setup by C<xsubpp> to indicate the stack base offset, used by
+the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro must be
+called prior to setup the C<MARK> variable.
 
 =for apidoc Amn|I32|items
-Variable which is setup by C<xsubpp> to indicate the number of
-items on the stack.  See L<perlxs/"Variable-length Parameter Lists">.
+Variable which is setup by C<xsubpp> to indicate the number of items on the
+stack. See L<perlxs/"Variable-length Parameter Lists">.
 
 =for apidoc Amn|I32|ix
-Variable which is setup by C<xsubpp> to indicate which of an
-XSUB's aliases was used to invoke it.  See L<perlxs/"The ALIAS: Keyword">.
+Variable which is setup by C<xsubpp> to indicate which of an XSUB's aliases was
+used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
 
 =for apidoc Am|SV*|ST|int ix
 Used to access elements on the XSUB's stack.
 
 =for apidoc Ay||XS|name
-Macro to declare an XSUB and its C parameter list.  This is handled by
-C<xsubpp>.  It is the same as using the more explicit C<XS_EXTERNAL> macro; the
+Macro to declare an XSUB and its C parameter list. This is handled by
+C<xsubpp>. It is the same as using the more explicit C<XS_EXTERNAL> macro; the
 latter is preferred.
 
 =for apidoc Ayu||XS_INTERNAL|name
-Macro to declare an XSUB and its C parameter list without exporting the symbols.
-This is handled by C<xsubpp> and generally preferable over exporting the XSUB
-symbols unnecessarily.
+Macro to declare an XSUB and its C parameter list without exporting the
+symbols. This is handled by C<xsubpp> and generally preferable over exporting
+the XSUB symbols unnecessarily.
 
 =for comment
 XS_INTERNAL marked 'u' because declaring a function static within our test
 function doesn't work
 
 =for apidoc Ay||XS_EXTERNAL|name
-Macro to declare an XSUB and its C parameter list explicitly exporting the symbols.
+Macro to declare an XSUB and its C parameter list explicitly exporting
+the symbols.
 
 =for apidoc Ay||XSPROTO|name
 Macro used by C<L</XS_INTERNAL>> and C<L</XS_EXTERNAL>> to declare a function
-prototype.  You probably shouldn't be using this directly yourself.
+prototype. You probably shouldn't be using this directly yourself.
 
 =for apidoc Amn;||dAX
-Sets up the C<ax> variable.
-This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
+Sets up the C<ax> variable. This is usually handled automatically by C<xsubpp>
+by calling C<dXSARGS>.
 
 =for apidoc Amn;||dAXMARK
-Sets up the C<ax> variable and stack marker variable C<mark>.
-This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
+Sets up the C<ax> variable and stack marker variable C<mark>. This is usually
+handled automatically by C<xsubpp> by calling C<dXSARGS>.
 
 =for apidoc Amn;||dITEMS
-Sets up the C<items> variable.
-This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
+Sets up the C<items> variable. This is usually handled automatically by
+C<xsubpp> by calling C<dXSARGS>.
 
 =for apidoc Amn;||dXSARGS
-Sets up stack and mark pointers for an XSUB, calling C<dSP> and C<dMARK>.
-Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
-This is usually handled automatically by C<xsubpp>.
+Sets up stack and mark pointers for an XSUB, calling C<dSP> and C<dMARK>. Sets
+up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>. This is
+usually handled automatically by C<xsubpp>.
 
 =for apidoc Amn;||dXSI32
-Sets up the C<ix> variable for an XSUB which has aliases.  This is usually
+Sets up the C<ix> variable for an XSUB which has aliases. This is usually
 handled automatically by C<xsubpp>.
 
 =for apidoc Amn;||dUNDERBAR
-Sets up any variable needed by the C<UNDERBAR> macro.  It used to define
-C<padoff_du>, but it is currently a noop.  However, it is strongly advised
-to still use it for ensuring past and future compatibility.
+Sets up any variable needed by the C<UNDERBAR> macro. It used to define
+C<padoff_du>, but it is currently a noop. However, it is strongly advised to
+still use it for ensuring past and future compatibility.
 
 =for apidoc AmnU||UNDERBAR
-The SV* corresponding to the C<$_> variable.  Works even if there
-is a lexical C<$_> in scope.
+The SV* corresponding to the C<$_> variable. Works even if there is a lexical
+C<$_> in scope.
 
 =cut
 */
 
+
 #ifndef PERL_UNUSED_ARG
 #  define PERL_UNUSED_ARG(x)  ((void)sizeof(x))
 #endif

cop.h

@@ -1,16 +1,17 @@
 /*    cop.h
  *
  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
- *    2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others
+ *    2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and
+ *    others
  *
  *    You may distribute under the terms of either the GNU General Public
  *    License or the Artistic License, as specified in the README file.
  *
- * Control ops (cops) are one of the two ops OP_NEXTSTATE and OP_DBSTATE,
- * that (loosely speaking) are statement separators.
- * They hold information important for lexical state and error reporting.
- * At run time, PL_curcop is set to point to the most recently executed cop,
- * and thus can be used to determine our current state.
+ * Control ops (cops) are one of the two ops OP_NEXTSTATE and OP_DBSTATE, that
+ * (loosely speaking) are statement separators. They hold information important
+ * for lexical state and error reporting. At run time, PL_curcop is set to
+ * point to the most recently executed cop, and thus can be used to determine
+ * our current state.
  */
 
 /* A jmpenv packages the state required to perform a proper non-local jump.
@@ -433,12 +434,12 @@ the octets.
 struct cop {
     BASEOP
     /* On LP64 putting this here takes advantage of the fact that BASEOP isn't
-       an exact multiple of 8 bytes to save structure padding.  */
+       an exact multiple of 8 bytes to save structure padding. */
     line_t      cop_line;           /* line # of this command */
     /* label for this construct is now stored in cop_hints_hash */
 #ifdef USE_ITHREADS
-    PADOFFSET   cop_stashoff;       /* offset into PL_stashpad, for the
-                                       package the line was compiled in */
+    PADOFFSET   cop_stashoff;       /* offset into PL_stashpad, for the package
+                                       the line was compiled in */
     char        *cop_file;          /* name of file this command is from */
 #else
     HV          *cop_stash;         /* package line was compiled in */
@@ -448,13 +449,13 @@ struct cop {
     U32         cop_seq;            /* parse sequence number */
     /* Beware. mg.c and warnings.pl assume the type of this is STRLEN *:  */
     STRLEN      *cop_warnings;      /* lexical warnings bitmask */
-    /* compile time state of %^H.  See the comment in op.c for how this is
-       used to recreate a hash to return from caller.  */
+    /* compile time state of %^H. See the comment in op.c for how this is used
+       to recreate a hash to return from caller. */
     COPHH       *cop_hints_hash;
     /* for now just a bitmask stored here.
-       If we get sufficient features this may become a pointer.
-       How these flags are stored is subject to change without
-       notice.  Use the macros to test for features.
+       If we get sufficient features this may become a pointer. How these flags
+       are stored is subject to change without notice. Use the macros to test
+       for features.
     */
     U32         cop_features;
 };
@@ -1026,7 +1027,7 @@ struct context {
 
 /* private flags for CXt_SUB and CXt_FORMAT */
 #define CXp_MULTICALL       0x10    /* part of a multicall (so don't tear down
-                                   context on exit). (not CXt_FORMAT) */
+                                       context on exit). (not CXt_FORMAT) */
 #define CXp_HASARGS         0x20
 #define CXp_SUB_RE          0x40    /* code called within regex, i.e. (?{}) */
 #define CXp_SUB_RE_FAKE     0x80    /* fake sub CX for (?{}) in current scope */
@@ -1064,8 +1065,8 @@ struct context {
     (   CxTYPE(cx) >= CXt_LOOP_ARY && CxTYPE(cx) <= CXt_LOOP_LIST)
 
 /* private flags for CXt_DEFER */
-#define CXp_FINALLY     0x20    /* `finally` block; semantically identical
-                                 * but matters for diagnostic messages */
+#define CXp_FINALLY     0x20    /* `finally` block; semantically identical but
+                                 * matters for diagnostic messages */
 
 /* deprecated old name before real try/catch was added */
 #define CXp_TRYBLOCK    CXp_EVALBLOCK
@@ -1084,33 +1085,33 @@ struct context {
 #endif
 
 /* extra flags for Perl_call_* routines */
-#define G_DISCARD                  0x4  /* Call FREETMPS.
-                                   Don't change this without consulting the
-                                   hash actions codes defined in hv.h */
-#define G_EVAL                     0x8  /* Assume eval {} around
-                                           subroutine call. */
+#define G_DISCARD                  0x4  /* Call FREETMPS. Don't change this
+                                           without consulting the hash actions
+                                           codes defined in hv.h */
+#define G_EVAL                     0x8  /* Assume eval {} around subroutine
+                                           call. */
 #define G_NOARGS                  0x10  /* Don't construct a @_ array. */
 #define G_KEEPERR                 0x20  /* Warn for errors, don't
                                            overwrite $@ */
 #define G_NODEBUG                 0x40  /* Disable debugging at toplevel.  */
 #define G_METHOD                  0x80  /* Calling method. */
-#define G_FAKINGEVAL             0x100  /* Faking an eval context for call_sv or
-                                   fold_constants. */
-#define G_UNDEF_FILL             0x200  /* Fill the stack with &PL_sv_undef
-                                   A special case for UNSHIFT in
-                                   Perl_magic_methcall().  */
+#define G_FAKINGEVAL             0x100  /* Faking an eval context for call_sv
+                                           or fold_constants. */
+#define G_UNDEF_FILL             0x200  /* Fill the stack with &PL_sv_undef A
+                                           special case for UNSHIFT in
+                                           Perl_magic_methcall(). */
 #define G_WRITING_TO_STDERR      0x400  /* Perl_write_to_stderr() is calling
-                                    Perl_magic_methcall().  */
+                                           Perl_magic_methcall(). */
 #define G_RE_REPARSING           0x800  /* compiling a run-time /(?{..})/ */
-#define G_METHOD_NAMED          0x1000  /* calling named method, eg
-                                           without :: or ' */
+#define G_METHOD_NAMED          0x1000  /* calling named method, eg without ::
+                                           or ' */
 #define G_RETHROW               0x2000  /* eval_sv(): re-throw any error */
 
 /* flag bits for PL_in_eval */
 #define EVAL_NULL                    0  /* not in an eval */
 #define EVAL_INEVAL                  1  /* some enclosing scope is an eval */
-#define EVAL_WARNONLY                2  /* used by yywarn() when
-                                           calling yyerror() */
+#define EVAL_WARNONLY                2  /* used by yywarn() when calling
+                                           yyerror() */
 #define EVAL_KEEPERR                 4  /* set by Perl_call_sv if G_KEEPERR */
 #define EVAL_INREQUIRE               8  /* The code is being required. */
 #define EVAL_RE_REPARSING         0x10  /* eval_sv() called with
@@ -1146,12 +1147,13 @@ struct stackinfo {
     I32                 si_cxmax;       /* maximum allocated index */
     I32                 si_cxsubix;     /* topmost sub/eval/format */
     I32                 si_type;        /* type of runlevel */
-    I32                 si_markoff;     /* offset where markstack begins for us.
-                                         * currently used only with DEBUGGING,
-                                         * but not #ifdef-ed for bincompat */
+    I32                 si_markoff;     /* offset where markstack begins for
+                                         * us. currently used only with
+                                         * DEBUGGING, but not #ifdef-ed for
+                                         * bincompat */
 #if defined DEBUGGING && !defined DEBUGGING_RE_ONLY
     /* high water mark: for checking if the stack was correctly extended /
- * tested for extension by each pp function */
+     * tested for extension by each pp function */
     SSize_t             si_stack_hwm;
 #endif
 

cv.h

@@ -117,27 +117,26 @@ See L<perlguts/Autoloading with XSUBs>.
  * renamed to avoid collision with an upcoming feature */
 #define CVf_NOWARN_AMBIGUOUS    0x0001
 
-#define CVf_LVALUE              0x0002  /* CV return value can be
-                                           used as lvalue */
+#define CVf_LVALUE              0x0002  /* CV return value can be used as
+                                           lvalue */
 #define CVf_CONST               0x0004  /* inlinable sub */
 #define CVf_ISXSUB              0x0008  /* CV is an XSUB, not pure perl.  */
 
 #define CVf_WEAKOUTSIDE         0x0010  /* CvOUTSIDE isn't ref counted */
 #define CVf_CLONE               0x0020  /* anon CV uses external lexicals */
 #define CVf_CLONED              0x0040  /* a clone of one of those */
 #define CVf_ANON                0x0080  /* CV is not pointed to by a GV */
-#define CVf_UNIQUE              0x0100  /* sub is only called once
-                                           (eg PL_main_cv,
-                                   require, eval). */
+#define CVf_UNIQUE              0x0100  /* sub is only called once (eg
+                                           PL_main_cv, require, eval). */
 #define CVf_NODEBUG             0x0200  /* no DB::sub indirection for this CV
-                                   (esp. useful for special XSUBs) */
+                                           (esp. useful for special XSUBs) */
 #define CVf_CVGV_RC             0x0400  /* CvGV is reference counted */
 #if defined(PERL_CORE) || defined(PERL_EXT)
 # define CVf_SLABBED     0x0800  /* Holds refcount on op slab  */
 #endif
 #define CVf_DYNFILE              0x1000     /* The filename is malloced  */
-#define CVf_AUTOLOAD             0x2000     /* SvPVX contains AUTOLOADed
-                                               sub name */
+#define CVf_AUTOLOAD             0x2000     /* SvPVX contains AUTOLOADed sub
+                                               name */
 #define CVf_HASEVAL              0x4000     /* contains string eval  */
 #define CVf_NAMED                0x8000     /* Has a name HEK */
 #define CVf_LEXICAL             0x10000     /* Omit package from name */

dosish.h

@@ -21,8 +21,8 @@
 #else
 #  define PERL_SYS_INIT_BODY(c,v)   \
        MALLOC_CHECK_TAINT2(*c,*v); PERLIO_INIT
-#  define BIT_BUCKET  "\\dev\\nul"    /* "wanna be like, umm, Newlined,
-                                     or somethin?" */
+#  define BIT_BUCKET  "\\dev\\nul"    /* "wanna be like, umm, Newlined, or
+                                         somethin?" */
 #endif
 
 /* Generally add things last-in first-terminated.  IO and memory terminations
@@ -66,21 +66,21 @@
 #define USE_STAT_RDEV       /**/
 
 /* ACME_MESS:
- *      This symbol, if defined, indicates that error messages should be
- *      should be generated in a format that allows the use of the Acme
- *      GUI/editor's autofind feature.
+ *      This symbol, if defined, indicates that error messages should be should
+ *      be generated in a format that allows the use of the Acme GUI/editor's
+ *      autofind feature.
  */
 #undef ACME_MESS        /**/
 
 /* ALTERNATE_SHEBANG:
- *      This symbol, if defined, contains a "magic" string which may be used
- *      as the first line of a Perl program designed to be executed directly
- *      by name, instead of the standard Unix #!.  If ALTERNATE_SHEBANG
- *      begins with a character other then #, then Perl will only treat
- *      it as a command line if it finds the string "perl" in the first
- *      word; otherwise it's treated as the first line of code in the script.
- *      (IOW, Perl won't hand off to another interpreter via an alternate
- *      shebang sequence that might be legal Perl code.)
+ *      This symbol, if defined, contains a "magic" string which may be used as
+ *      the first line of a Perl program designed to be executed directly by
+ *      name, instead of the standard Unix #!. If ALTERNATE_SHEBANG begins with
+ *      a character other then #, then Perl will only treat it as a command
+ *      line if it finds the string "perl" in the first word; otherwise it's
+ *      treated as the first line of code in the script. (IOW, Perl won't hand
+ *      off to another interpreter via an alternate shebang sequence that might
+ *      be legal Perl code.)
  */
 /* #define ALTERNATE_SHEBANG "#!" / **/