Skip to content

Commit 322b787

Browse files
committed
perlapi: s/encapsulated argument list/va_list/g
The former terminology was what was long used in perlapi, but I never was happy with it. Tony Cook suggested va_list, which is standard terminology. There is even a Linux man page for it.
1 parent 215e36f commit 322b787

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

deb.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ C<deb> and C<deb_nocontext> differ only in that C<deb_nocontext> does not take
5757
a thread context (C<aTHX>) parameter, so is used in situations where the caller
5858
doesn't already have the thread context.
5959
60-
C<vdeb> is the same as C<deb> except C<args> are an encapsulated argument list.
60+
C<vdeb> is the same as C<deb> except C<args> is a pointer to a C<va_list>.
6161
6262
=cut
6363
*/

op.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8504,7 +8504,7 @@ So use the latter when you get a compilation error about C<pTHX>.
85048504
=for apidoc Amnh||PERL_LOADMOD_IMPORT_OPS
85058505

85068506
=for apidoc vload_module
8507-
Like C<L</load_module>> but the arguments are an encapsulated argument list.
8507+
Like C<L</load_module>> but the arguments are a C<va_list>.
85088508

85098509
=cut */
85108510

sv.c

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10439,7 +10439,7 @@ so is used in situations where the caller doesn't already have the thread
1043910439
context.
1044010440

1044110441
=for apidoc vnewSVpvf
10442-
Like C<L</newSVpvf>> but the arguments are an encapsulated argument list.
10442+
Like C<L</newSVpvf>> but the arguments are a C<va_list>.
1044310443

1044410444
=cut
1044510445
*/
@@ -11600,7 +11600,7 @@ eventually calling it. It does not handle magic; the forms whose name contains
1160011600
C<_mg> additionally handle 'set' magic after calling it.
1160111601

1160211602
It has two sets of argument lists, only one of which is used in any given call.
11603-
The first set, C<args>, is an encapsulated argument list of pointers to C
11603+
The first set, C<args>, is a pointer to a C<va_list> of pointers to C
1160411604
strings. If it is NULL, the other list, C<svargs>, is used; it is an array
1160511605
of pointers to SV's. C<sv_count> gives how many there are in the list.
1160611606

@@ -11633,7 +11633,7 @@ The forms whose name contains C<_no_context> do not take a thread
1163311633
context (C<aTHX>) parameter, so are used in situations where the caller
1163411634
doesn't already have the thread context.
1163511635

11636-
The forms whose name contains C<vset> use an encapsulated argument list, the
11636+
The forms whose name contains C<vset> use a C<va_list>, the
1163711637
other forms use C<sprintf>-style arguments.
1163811638

1163911639
There are no other differences between the forms.
@@ -11749,7 +11749,7 @@ C<sv_vcatpvfn_flags> is the most general, and all the other forms are
1174911749
implemented by eventually calling it.
1175011750

1175111751
It has two sets of argument lists, only one of which is used in any given call.
11752-
The first set, C<args>, is an encapsulated argument list of pointers to C
11752+
The first set, C<args>, is a pointer to a C<va_list> of pointers to C
1175311753
strings. If it is NULL, the other list, C<svargs>, is used; it is an array
1175411754
of pointers to SV's. C<sv_count> gives how many there are in the list.
1175511755

@@ -11792,7 +11792,7 @@ The forms whose name contains C<_no_context> do not take a thread
1179211792
context (C<aTHX>) parameter, so are used in situations where the caller
1179311793
doesn't already have the thread context.
1179411794

11795-
The forms whose name contains C<vcat> use an encapsulated argument list, the
11795+
The forms whose name contains C<vcat> use a C<va_list>, the
1179611796
other forms use C<sprintf>-style arguments.
1179711797

1179811798
There are no other differences between the forms.

util.c

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1439,8 +1439,8 @@ not take a thread context (C<aTHX>) parameter, so is used in situations where
14391439
the caller doesn't already have the thread context (and can be called without
14401440
the C<Perl_> prefix.
14411441
1442-
C<vform> is the same as C<form> except the arguments are an encapsulated
1443-
argument list. It does need a thread context parameter, but that is supplied
1442+
C<vform> is the same as C<form> except the arguments are a C<va_list>.
1443+
It does need a thread context parameter, but that is supplied
14441444
automatically when called without the C<Perl_> prefix.
14451445
14461446
=cut
@@ -1481,8 +1481,8 @@ C<mess> and C<mess_nocontext> differ only in that C<mess_nocontext> does
14811481
not take a thread context (C<aTHX>) parameter, so is used in situations where
14821482
the caller doesn't already have the thread context.
14831483
1484-
C<vmess> is the same as C<mess> except the arguments are an encapsulated
1485-
argument list. It needs a thread context parameter only when called with the
1484+
C<vmess> is the same as C<mess> except the arguments are a <va_list>.
1485+
It needs a thread context parameter only when called with the
14861486
C<Perl_> prefix.
14871487
14881488
Normally, the resulting message is returned in a new mortal SV.

0 commit comments

Comments
 (0)