diff mbox series

system_data_types.7: void *: Add info about generic function parameters and return value

Message ID 20201002094315.17832-1-colomar.6.4.3@gmail.com
State Not Applicable
Headers show
Series system_data_types.7: void *: Add info about generic function parameters and return value | expand

Commit Message

Alejandro Colomar Oct. 2, 2020, 9:43 a.m. UTC
Reported-by: Paul Eggert <eggert@cs.ucla.edu>
Reported-by: David Laight <David.Laight@ACULAB.COM>
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---

Paul and David,
Thanks for your input!

Alex


 man7/system_data_types.7 | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
diff mbox series

Patch

diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
index aab64e002..6451782db 100644
--- a/man7/system_data_types.7
+++ b/man7/system_data_types.7
@@ -1903,6 +1903,16 @@  and back.
 .PP
 Conversions from and to any other pointer type are done implicitly,
 not requiring casts at all.
+Note that this feature prevents any kind of type checking:
+the programmer should be careful not to cast a
+.I void *
+value to a type incompatible to that of the underlying data,
+because that would result in undefined behavior.
+.PP
+This type is useful in function parameters and return value
+to allow passing values of any type.
+The function will usually use some mechanism to know
+of which type the underlying data passed to the function really is.
 .PP
 A value of this type can't be dereferenced,
 as it would give a value of type
@@ -1926,6 +1936,12 @@  values.
 Conforming to:
 C99 and later; POSIX.1-2001 and later.
 .PP
+See also:
+.BR malloc (3),
+.BR memcmp (3),
+.BR memcpy (3),
+.BR memset (3)
+.PP
 See also the
 .I intptr_t
 and