Skip to content

Commit 5ab6a04

Browse files
committed
perlxs.pod: update NOT_IMPLEMENTED_YET: keyword
This keyword formerly wasn't documented. The docs now say "this is what it is, but don't use it".
1 parent 4e8a05c commit 5ab6a04

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

dist/ExtUtils-ParseXS/lib/perlxs.pod

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3166,9 +3166,20 @@ These are:
31663166
mPUSHpvs("string") create+push mortal and set to the literal string
31673167
(perl 5.38.0 onwards)
31683168

3169-
=head3 NOT_IMPLEMENTED_YET
3169+
=head3 The NOT_IMPLEMENTED_YET: Keyword
31703170

3171-
XXX TBC
3171+
void
3172+
foo(int a)
3173+
NOT_IMPLEMENTED_YET:
3174+
3175+
This keyword, as a fourth alternative to C<CODE>, C<PPCODE> and autocall,
3176+
generates a main body for the XSUB consisting solely of the C code:
3177+
3178+
Perl_croak(aTHX_ "Foo::Bar::foo: not implemented yet");
3179+
3180+
The current implementation is quite buggy in terms of parsing and where
3181+
the keyword can appear within an XSUB, so it's generally better to avoid
3182+
it. It is documented here for completeness.
31723183

31733184
=head2 The XSUB Output Part
31743185

0 commit comments

Comments
 (0)