Commit 05787231b6 for perl
commit 05787231b6cc495fb93d28ba78352bac699267da
Author: Karl Williamson <khw@cpan.org>
Date: Thu Oct 22 04:11:01 2026 -0600
perlapi,perlintern: Small clarifications
Remove a trailing blank;
Note typedefs, etc are also included.
Replace redundant and slightly wrong text by the text it is redundant
with
Slight wording changes.
diff --git a/autodoc.pl b/autodoc.pl
index 1d8ed90e3a..153df3e8e6 100644
--- a/autodoc.pl
+++ b/autodoc.pl
@@ -1866,7 +1866,7 @@ sub docout ($fh, $section_name, $element_name, $docref) {
. ')';
}
else {
- # We accept empty pod for backwards compatibilty-only elements.
+ # We accept empty pod for backwards compatibilty-only elements.
# Doing so allows a modicum of documentation without us having to
# work at figuring out what to say for something that shouldn't be
# being used anyway.
@@ -3126,9 +3126,9 @@ $api{hdr} = <<"_EOB_";
|
|This file contains most of the documentation of the perl public API, as
|generated by F<embed.pl>. Specifically, it is a listing of functions,
-|macros, flags, and variables that may be used by extension writers. Besides
-|L<perlintern> and F<$config_h>, some items are listed here as being actually
-|documented in another pod.
+|macros, flags, typedefs, structs, unions, enums, and variables that may be
+|used by extension writers. Besides L<perlintern> and F<$config_h>, some
+|items are listed here as being actually documented in another pod.
|
|L<At the end|/$undocumented_scn> is a list of functions which have yet
|to be documented. Patches welcome! The interfaces of these are subject to
@@ -3211,9 +3211,6 @@ $api{hdr} = <<"_EOB_";
|L<perl5-porters\@perl.org|mailto:perl5-porters\@perl.org>.
|
|The API elements are grouped by functionality into sections, as follows.
-|Within sections the elements are ordered alphabetically, ignoring case, with
-|non-leading underscores sorted first, and leading underscores and digits
-|sorted last.
|
|=over $standard_indent
@@ -3221,7 +3218,9 @@ $api{hdr} = <<"_EOB_";
|
|=back
|
-|The listing below is alphabetical, case insensitive.
+|Within sections the elements are ordered alphabetically, ignoring case, with
+|non-leading underscores sorted first, and leading underscores and digits
+|sorted last.
_EOB_
$api{footer} = <<"_EOE_";
@@ -3282,15 +3281,16 @@ $intern{hdr} = <<"_EOB_";
|=head1 NAME
|
|perlintern - autogenerated documentation of purely B<internal>
-|Perl functions
+|Perl functions, macros, I<etc>.
|
|=head1 DESCRIPTION
|X<internal Perl functions> X<interpreter functions>
|
-|This file is the autogenerated documentation of functions in the
+|This file is the autogenerated documentation of functions,
+|macros, flags, typedefs, structs, unions, enums, and variables in the
|Perl interpreter that are documented using Perl's internal documentation
|format but are not marked as part of the Perl API. In other words,
-|B<they are not for use in extensions>!
+|B<they are not for use in generic XS modules>!
|It has the same general form as L<perlapi>, though some sections may be
|empty.