In perl.git, the branch blead has been updated <https://perl5.git.perl.org/perl.git/commitdiff/9187ff187d789acd06d85952c8c4481a506a75fd?hp=a377c856ab6afcf60515844b8ed6793fe5de6330>
- Log ----------------------------------------------------------------- commit 9187ff187d789acd06d85952c8c4481a506a75fd Author: Karl Williamson <[email protected]> Date: Sun Jul 21 13:12:43 2019 -0600 embed.fnc: Fix wrong comment commit fe38a294230dd9b948b4f72ffffb6cba520564c0 Author: Karl Williamson <[email protected]> Date: Sun Jul 21 13:00:13 2019 -0600 embed.fnc: Clarify wording An 'A' flagged element is accessible everywhere. I think that is clearer than the previous 'Available' commit 558a6899681ac9d2e837bdfbdb9df569ce55d017 Author: Karl Williamson <[email protected]> Date: Tue Jul 23 11:05:18 2019 -0600 Document my_sprintf as deprecated It turns out that Devel::PPPort needs a documentation entry for this function in order to not have to special case it. So, add a brief explanation as to why its deprecated. ----------------------------------------------------------------------- Summary of changes: embed.fnc | 9 ++++----- perl.h | 13 ++++++++++--- 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/embed.fnc b/embed.fnc index aa23c1a6c9..3f1d2ec665 100644 --- a/embed.fnc +++ b/embed.fnc @@ -60,14 +60,13 @@ : to embed.pl; some only to autodoc.pl, and others only to makedef.pl. The : comments here don't include how Devel::PPPort or diag.t use them: : -: A Available fully everywhere (usually part of the public API): +: A Accessible fully everywhere (usually part of the public API): : : add entry to the list of exported symbols (unless e or m); : any doc entry goes in perlapi.pod rather than perlintern.pod. If -: none specified, autodoc.pl does not list this function/macro as -: part of the public API. If x isn't specified, and no -: documentation is furnished, autodoc.pl lists this in perlapi as -: existing and being undocumented. +: no documentation is furnished, x controls what happens: If x +: isn't specified, autodoc.pl lists this in perlapi as existing and +: being undocumented; otherwise it simply isn't listed. : makes '#define foo Perl_foo' scope not just for PERL_CORE/PERL_EXT : : If the function is only exported for use in a public macro, see X. diff --git a/perl.h b/perl.h index 37b2637ca1..c993eccdb9 100644 --- a/perl.h +++ b/perl.h @@ -1628,9 +1628,15 @@ This replaces any read-only SV with a fresh SV and removes any magic. /* This used to be conditionally defined based on whether we had a sprintf() * that correctly returns the string length (as required by C89), but we no * longer need that. XS modules can (and do) use this name, so it must remain - * a part of the API that's visible to modules. But we no longer document it - * either (because using sprintf() rather than snprintf() is almost always - * a bad idea). */ + * a part of the API that's visible to modules. + +=for apidoc ATmD|int|my_sprintf|NN char *buffer|NN const char *pat|... + +Do NOT use this due to the possibility of overflowing C<buffer>. Instead use +my_snprintf() + +=cut +*/ #define my_sprintf sprintf /* @@ -6564,6 +6570,7 @@ expression, but with an empty argument list, like this: #endif /* !USE_LOCALE_NUMERIC */ #define Atof my_atof +/* XXX document this , maybe other similar ones*/ #define Strtod my_strtod #if defined(HAS_STRTOD) \ -- Perl5 Master Repository
