summaryrefslogtreecommitdiff
path: root/perl.h
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2020-08-17 19:31:04 -0600
committerKarl Williamson <khw@cpan.org>2020-08-17 19:33:49 -0600
commit00b72c9f5c9652dedbe8b044b5d73da757211c96 (patch)
treeec1b943e9a778c1e8e7974a55a4cdec3fa93de7d /perl.h
parentfd2362a2b8de4b1ccfd467f7d19244c6d0ded301 (diff)
downloadperl-00b72c9f5c9652dedbe8b044b5d73da757211c96.tar.gz
perl.h: Add some pod formatting.
This somehow got left off the previous commit.
Diffstat (limited to 'perl.h')
-rw-r--r--perl.h10
1 files changed, 5 insertions, 5 deletions
diff --git a/perl.h b/perl.h
index cc73f6cb38..104b411856 100644
--- a/perl.h
+++ b/perl.h
@@ -433,20 +433,20 @@ compilation causes it be used just some times.
=for apidoc Am||PERL_UNUSED_RESULT|void x
This macro indicates to discard the return value of the function call inside
-it, e.g.
+it, I<e.g.>,
PERL_UNUSED_RESULT(foo(a, b))
-The main reason for this is that the combination of gcc -Wunused-result
-(part of -Wall) and the __attribute__((warn_unused_result)) cannot
-be silenced with casting to void. This causes trouble when the system
+The main reason for this is that the combination of C<gcc -Wunused-result>
+(part of C<-Wall>) and the C<__attribute__((warn_unused_result))> cannot
+be silenced with casting to C<void>. This causes trouble when the system
header files use the attribute.
Use C<PERL_UNUSED_RESULT> sparingly, though, since usually the warning
is there for a good reason: you might lose success/failure information,
or leak resources, or changes in resources.
-But sometimes you just want to ignore the return value, e.g. on
+But sometimes you just want to ignore the return value, I<e.g.>, on
codepaths soon ending up in abort, or in "best effort" attempts,
or in situations where there is no good way to handle failures.