This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Document D_PPP_ prefix for macros
authorPali <pali@cpan.org>
Mon, 17 Jun 2019 13:54:13 +0000 (15:54 +0200)
committerNicolas R <atoomic@cpan.org>
Fri, 27 Sep 2019 20:14:31 +0000 (14:14 -0600)
(cherry picked from commit 7556987e03558cd2f200df996ee222da58e5889c)
Signed-off-by: Nicolas R <atoomic@cpan.org>
dist/Devel-PPPort/HACKERS

index 1db7f34..ff215a4 100644 (file)
@@ -244,6 +244,13 @@ the line C<__UNDEFINED__> to the C<=provides> section to get all macros
 implemented this way to be imported into this section, so they all get
 documented as being provided.
 
+If you need to define a helper macro which is not part of C<Devel::PPPort> API
+and its usage is only for definition of other C<Devel::PPPort> macros then use
+the C<D_PPP_> prefix for this macro name (e.g. C<D_PPP_SVPV_NOLEN_LP_ARG>).
+Some C<Devel::PPPort> scripts would report a warning when there is defined a
+macro which is not part of Perl public API, except those macros which start
+with the C<D_PPP_> prefix.
+
 Version checking can be tricky if you want to do it correct.
 You can use