man/man7/man-pages.7: Document formatting of foward declarations of function parameters

Reported-by: Helge Kreutzmann <debian@helgefjell.de>
Signed-off-by: Alejandro Colomar <alx@kernel.org>

diff --git a/man/man7/man-pages.7 b/man/man7/man-pages.7
index 784fd1a91e2e4ffd44737e002c79078f95992e1c..796bac47b769233db50179dd760580b63970adfd 100644 (file)
--- a/man/man7/man-pages.7
+++ b/man/man7/man-pages.7
@@ -484,6 +484,19 @@ Wrap the function prototype(s) in a
 .IR .nf / .fi
 pair to prevent filling.
 .P
+Forward declarations of parameters in functions
+should not use bold nor italics;
+this helps distinguish them visually from actual parameters.
+As an example:
+.P
+.in +4n
+.nf
+.BR "int snprintf(" "size_t size;"
+.BI "             char " str "[restrict " size "], size_t " size ,
+.BI "             const char *restrict " format ", ...);"
+.fi
+.in
+.P
 In general, where more than one function prototype is shown in the SYNOPSIS,
 the prototypes should
 .I not