From: David Mitchell Date: Sun, 7 Feb 2010 18:44:34 +0000 (+0000) Subject: alphabetically sort flag descriptions in embed.fnc X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=7d354ab0f583b785693921eacc568c9bb8fea1e0;p=p5sagit%2Fp5-mst-13.2.git alphabetically sort flag descriptions in embed.fnc --- diff --git a/embed.fnc b/embed.fnc index d61ba8d..91bc6ee 100644 --- a/embed.fnc +++ b/embed.fnc @@ -8,29 +8,29 @@ : : flags are single letters with following meanings: : A member of public API +: a allocates memory a la malloc/calloc. Is also "R". +: b binary backward compatibility; function is a macro +: but has also Perl_ implementation (which is exported) +: D function is deprecated +: d function has documentation with its source +: E visible to extensions included in the Perl core +: f function takes printf style format string, varargs +: M may change : m Implemented as a macro - no export, no : proto, no #define -: d function has documentation with its source -: D function is deprecated -: s static function, should have an S_ prefix in -: source file; for macros (m), suffix the usage -: example with a semicolon : n has no implicit interpreter/thread context argument -: p function has a Perl_ prefix -: f function takes printf style format string, varargs -: r function never returns : o has no compatibility macro (#define foo Perl_foo) -: x not exported -: X explicitly exported -: M may change -: E visible to extensions included in the Perl core -: b binary backward compatibility; function is a macro -: but has also Perl_ implementation (which is exported) -: U suppress usage example in autogenerated documentation -: a allocates memory a la malloc/calloc. Is also "R". -: R Return value must not be ignored. : P pure function: no effects except the return value; : return value depends only on parms and/or globals +: p function has a Perl_ prefix +: R Return value must not be ignored. +: r function never returns +: s static function, should have an S_ prefix in +: source file; for macros (m), suffix the usage +: example with a semicolon +: U suppress usage example in autogenerated documentation +: X explicitly exported +: x not exported : (see also L for those flags.) : : Pointer parameters that must not be passed NULLs should be prefixed with NN.