This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perlapi: Split section Display and Dump
authorKarl Williamson <khw@cpan.org>
Fri, 6 Nov 2020 00:39:40 +0000 (17:39 -0700)
committerKarl Williamson <khw@cpan.org>
Fri, 6 Nov 2020 15:27:52 +0000 (08:27 -0700)
into Debugging and Display sections

autodoc.pl
dump.c
util.c

index f433129..f52264c 100644 (file)
@@ -111,7 +111,8 @@ my $concurrency_scn = 'Concurrency';
 my $COP_scn = 'COP Hint Hashes';
 my $CV_scn = 'CV Handling';
 my $custom_scn = 'Custom Operators';
-my $dump_scn = 'Display and Dump functions';
+my $debugging_scn = 'Debugging';
+my $display_scn = 'Display functions';
 my $embedding_scn = 'Embedding and Interpreter Cloning';
 my $errno_scn = 'Errno';
 my $exceptions_scn = 'Exception Handling (simple) Macros';
@@ -180,7 +181,8 @@ my %valid_sections = (
     },
 
     $custom_scn => {},
-    $dump_scn => {},
+    $debugging_scn => {},
+    $display_scn => {},
     $embedding_scn => {},
     $errno_scn => {},
     $exceptions_scn => {},
@@ -1033,7 +1035,7 @@ sub parse_config_h {
                 $configs{$name}{'section'} = $formats_scn;
             }
             elsif ($name =~ / BACKTRACE /x) {
-                $configs{$name}{'section'} = $dump_scn;
+                $configs{$name}{'section'} = $debugging_scn;
             }
             elsif ($name =~ / ALLOC $sb /x) {
                 $configs{$name}{'section'} = $memory_scn;
diff --git a/dump.c b/dump.c
index e395790..0004f49 100644 (file)
--- a/dump.c
+++ b/dump.c
@@ -21,7 +21,7 @@
  *
  * It also holds the debugging version of the  runops function.
 
-=for apidoc_section Display and Dump functions
+=for apidoc_section $display
  */
 
 #include "EXTERN.h"
@@ -639,6 +639,7 @@ S_opdump_link(pTHX_ const OP *base, const OP *o, PerlIO *file)
 }
 
 /*
+=for apidoc_section $debugging
 =for apidoc dump_all
 
 Dumps the entire optree of the current program starting at C<PL_main_root> to 
diff --git a/util.c b/util.c
index c1a441c..5989a58 100644 (file)
--- a/util.c
+++ b/util.c
@@ -1508,7 +1508,7 @@ Perl_form_nocontext(const char* pat, ...)
 #endif /* PERL_IMPLICIT_CONTEXT */
 
 /*
-=for apidoc_section Display and Dump functions
+=for apidoc_section $display
 =for apidoc form
 =for apidoc_item form_nocontext
 
@@ -6340,7 +6340,7 @@ static void atos_symbolize(atos_context* ctx,
 #endif /* #ifdef PERL_DARWIN */
 
 /*
-=for apidoc_section Display and Dump functions
+=for apidoc_section $debugging
 =for apidoc get_c_backtrace
 
 Collects the backtrace (aka "stacktrace") into a single linear
@@ -6592,7 +6592,6 @@ Deallocates a backtrace received from get_c_backtrace.
 */
 
 /*
-=for apidoc_section Display and Dump functions
 =for apidoc get_c_backtrace_dump
 
 Returns a SV containing a dump of C<depth> frames of the call stack, skipping