Capitalise magic descriptions consistently
authorFather Chrysostomos <sprout@cpan.org>
Wed, 24 Sep 2014 08:45:47 +0000 (01:45 -0700)
committerFather Chrysostomos <sprout@cpan.org>
Sat, 11 Oct 2014 04:56:31 +0000 (21:56 -0700)
mg_raw.h
mg_vtable.h
pod/perlguts.pod
regen/mg_vtable.pl

index e6bda5d..4b3d35d 100644 (file)
--- a/mg_raw.h
+++ b/mg_raw.h
@@ -11,7 +11,7 @@
     { '#', "want_vtbl_arylen | PERL_MAGIC_VALUE_MAGIC",
       "/* arylen '#' Array length ($#ary) */" },
     { '%', "magic_vtable_max | PERL_MAGIC_VALUE_MAGIC",
-      "/* rhash '%' extra data for restricted hashes */" },
+      "/* rhash '%' Extra data for restricted hashes */" },
     { '&', "magic_vtable_max",
       "/* proto '&' my sub prototype CV */" },
     { '*', "want_vtbl_debugvar",
     { '.', "want_vtbl_pos | PERL_MAGIC_VALUE_MAGIC",
       "/* pos '.' pos() lvalue */" },
     { ':', "magic_vtable_max | PERL_MAGIC_VALUE_MAGIC",
-      "/* symtab ':' extra data for symbol tables */" },
+      "/* symtab ':' Extra data for symbol tables */" },
     { '<', "want_vtbl_backref | PERL_MAGIC_READONLY_ACCEPTABLE | PERL_MAGIC_VALUE_MAGIC",
-      "/* backref '<' for weak ref data */" },
+      "/* backref '<' For weak ref data */" },
     { '@', "magic_vtable_max | PERL_MAGIC_VALUE_MAGIC",
-      "/* arylen_p '@' to move arylen out of XPVAV */" },
+      "/* arylen_p '@' To move arylen out of XPVAV */" },
     { 'B', "want_vtbl_regexp | PERL_MAGIC_READONLY_ACCEPTABLE | PERL_MAGIC_VALUE_MAGIC",
       "/* bm 'B' Boyer-Moore (fast string search) */" },
     { 'c', "want_vtbl_ovrld",
@@ -63,7 +63,7 @@
     { 'q', "want_vtbl_packelem",
       "/* tiedscalar 'q' Tied scalar or handle */" },
     { 'r', "want_vtbl_regexp | PERL_MAGIC_READONLY_ACCEPTABLE | PERL_MAGIC_VALUE_MAGIC",
-      "/* qr 'r' precompiled qr// regex */" },
+      "/* qr 'r' Precompiled qr// regex */" },
     { 'S', "magic_vtable_max",
       "/* sig 'S' %SIG hash */" },
     { 's', "want_vtbl_sigelem",
@@ -85,7 +85,7 @@
     { '\\', "want_vtbl_lvref",
       "/* lvref '\\' Lvalue reference in list assignment */" },
     { ']', "want_vtbl_checkcall | PERL_MAGIC_VALUE_MAGIC",
-      "/* checkcall ']' inlining/mutation of call to this CV */" },
+      "/* checkcall ']' Inlining/mutation of call to this CV */" },
     { '~', "magic_vtable_max",
       "/* ext '~' Available for use by extensions */" },
 
index 38ca08e..2ee6361 100644 (file)
 
 #define PERL_MAGIC_sv             '\0' /* Special scalar variable */
 #define PERL_MAGIC_arylen         '#' /* Array length ($#ary) */
-#define PERL_MAGIC_rhash          '%' /* extra data for restricted hashes */
+#define PERL_MAGIC_rhash          '%' /* Extra data for restricted hashes */
 #define PERL_MAGIC_proto          '&' /* my sub prototype CV */
 #define PERL_MAGIC_debugvar       '*' /* $DB::single, signal, trace vars */
 #define PERL_MAGIC_pos            '.' /* pos() lvalue */
-#define PERL_MAGIC_symtab         ':' /* extra data for symbol tables */
-#define PERL_MAGIC_backref        '<' /* for weak ref data */
-#define PERL_MAGIC_arylen_p       '@' /* to move arylen out of XPVAV */
+#define PERL_MAGIC_symtab         ':' /* Extra data for symbol tables */
+#define PERL_MAGIC_backref        '<' /* For weak ref data */
+#define PERL_MAGIC_arylen_p       '@' /* To move arylen out of XPVAV */
 #define PERL_MAGIC_bm             'B' /* Boyer-Moore (fast string search) */
 #define PERL_MAGIC_overload_table 'c' /* Holds overload table (AMT) on stash */
 #define PERL_MAGIC_regdata        'D' /* Regex match position data
@@ -43,7 +43,7 @@
 #define PERL_MAGIC_tied           'P' /* Tied array or hash */
 #define PERL_MAGIC_tiedelem       'p' /* Tied array or hash element */
 #define PERL_MAGIC_tiedscalar     'q' /* Tied scalar or handle */
-#define PERL_MAGIC_qr             'r' /* precompiled qr// regex */
+#define PERL_MAGIC_qr             'r' /* Precompiled qr// regex */
 #define PERL_MAGIC_sig            'S' /* %SIG hash */
 #define PERL_MAGIC_sigelem        's' /* %SIG hash element */
 #define PERL_MAGIC_taint          't' /* Taintedness */
@@ -56,7 +56,7 @@
 #define PERL_MAGIC_defelem        'y' /* Shadow "foreach" iterator variable /
                                          smart parameter vivification */
 #define PERL_MAGIC_lvref          '\\' /* Lvalue reference in list assignment */
-#define PERL_MAGIC_checkcall      ']' /* inlining/mutation of call to this CV */
+#define PERL_MAGIC_checkcall      ']' /* Inlining/mutation of call to this CV */
 #define PERL_MAGIC_ext            '~' /* Available for use by extensions */
 
 enum {         /* pass one of these to get_vtbl */
index b9ab1e8..ab2885d 100644 (file)
@@ -1166,16 +1166,16 @@ will be lost.
  --------------------------   ------         -------------
  \0 PERL_MAGIC_sv             vtbl_sv        Special scalar variable
  #  PERL_MAGIC_arylen         vtbl_arylen    Array length ($#ary)
- %  PERL_MAGIC_rhash          (none)         extra data for restricted
+ %  PERL_MAGIC_rhash          (none)         Extra data for restricted
                                              hashes
  &  PERL_MAGIC_proto          (none)         my sub prototype CV
  *  PERL_MAGIC_debugvar       vtbl_debugvar  $DB::single, signal, trace
                                              vars
  .  PERL_MAGIC_pos            vtbl_pos       pos() lvalue
- :  PERL_MAGIC_symtab         (none)         extra data for symbol
+ :  PERL_MAGIC_symtab         (none)         Extra data for symbol
                                              tables
- <  PERL_MAGIC_backref        vtbl_backref   for weak ref data
- @  PERL_MAGIC_arylen_p       (none)         to move arylen out of XPVAV
+ <  PERL_MAGIC_backref        vtbl_backref   For weak ref data
+ @  PERL_MAGIC_arylen_p       (none)         To move arylen out of XPVAV
  B  PERL_MAGIC_bm             vtbl_regexp    Boyer-Moore 
                                              (fast string search)
  c  PERL_MAGIC_overload_table vtbl_ovrld     Holds overload table 
@@ -1203,7 +1203,7 @@ will be lost.
  P  PERL_MAGIC_tied           vtbl_pack      Tied array or hash
  p  PERL_MAGIC_tiedelem       vtbl_packelem  Tied array or hash element
  q  PERL_MAGIC_tiedscalar     vtbl_packelem  Tied scalar or handle
- r  PERL_MAGIC_qr             vtbl_regexp    precompiled qr// regex
+ r  PERL_MAGIC_qr             vtbl_regexp    Precompiled qr// regex
  S  PERL_MAGIC_sig            (none)         %SIG hash
  s  PERL_MAGIC_sigelem        vtbl_sigelem   %SIG hash element
  t  PERL_MAGIC_taint          vtbl_taint     Taintedness
@@ -1220,7 +1220,7 @@ will be lost.
                                              vivification
  \  PERL_MAGIC_lvref          vtbl_lvref     Lvalue reference in list
                                              assignment
- ]  PERL_MAGIC_checkcall      vtbl_checkcall inlining/mutation of call
+ ]  PERL_MAGIC_checkcall      vtbl_checkcall Inlining/mutation of call
                                              to this CV
  ~  PERL_MAGIC_ext            (none)         Available for use by
                                              extensions
index 3277377..cb61908 100644 (file)
@@ -72,7 +72,7 @@ my %mg =
      tiedscalar => { char => 'q', vtable => 'packelem',
                     desc => 'Tied scalar or handle' },
      qr => { char => 'r', vtable => 'regexp', value_magic => 1, 
-            readonly_acceptable => 1, desc => 'precompiled qr// regex' },
+            readonly_acceptable => 1, desc => 'Precompiled qr// regex' },
      sig => { char => 'S', desc => '%SIG hash' },
      sigelem => { char => 's', vtable => 'sigelem',
                  desc => '%SIG hash element' },
@@ -98,16 +98,16 @@ my %mg =
      pos => { char => '.', vtable => 'pos', value_magic => 1,
              desc => 'pos() lvalue' },
      backref => { char => '<', vtable => 'backref', value_magic => 1,
-                 readonly_acceptable => 1, desc => 'for weak ref data' },
+                 readonly_acceptable => 1, desc => 'For weak ref data' },
      symtab => { char => ':', value_magic => 1,
-                desc => 'extra data for symbol tables' },
+                desc => 'Extra data for symbol tables' },
      rhash => { char => '%', value_magic => 1,
-               desc => 'extra data for restricted hashes' },
+               desc => 'Extra data for restricted hashes' },
      arylen_p => { char => '@', value_magic => 1,
-                  desc => 'to move arylen out of XPVAV' },
+                  desc => 'To move arylen out of XPVAV' },
      ext => { char => '~', desc => 'Available for use by extensions' },
      checkcall => { char => ']', value_magic => 1, vtable => 'checkcall',
-                   desc => 'inlining/mutation of call to this CV'},
+                   desc => 'Inlining/mutation of call to this CV'},
      debugvar => { char => '*', desc => '$DB::single, signal, trace vars',
                   vtable => 'debugvar' },
      lvref => { char => '\\', vtable => 'lvref',