svn commit: r354888 - stable/12/lib/libc/gen

[Konstantin Belousov]

Author: kib
Date: Wed Nov 20 10:27:43 2019
New Revision: 354888
URL: https://svnweb.freebsd.org/changeset/base/354888

Log:
  MFC r354787:
  Document required size of buffer for elf_aux_info(3).

Modified:
  stable/12/lib/libc/gen/auxv.3
Directory Properties:
  stable/12/   (props changed)

Modified: stable/12/lib/libc/gen/auxv.3
==============================================================================
--- stable/12/lib/libc/gen/auxv.3	Wed Nov 20 10:25:50 2019	(r354887)
+++ stable/12/lib/libc/gen/auxv.3	Wed Nov 20 10:27:43 2019	(r354888)
@@ -24,7 +24,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd April 25, 2019
+.Dd November 17, 2019
 .Dt ELF_AUX_INFO 3
 .Os
 .Sh NAME
@@ -44,24 +44,35 @@ function retrieves the auxiliary info vector requested
 The information is stored into the provided buffer if it will fit.
 The following values, defined in
 .In sys/elf_common.h
-can be requested:
+can be requested (corresponding buffer sizes are specified in parenthesis):
 .Bl -tag -width AT_OSRELDATE
 .It AT_CANARY
-The canary value for SSP.
+The canary value for SSP (arbitrary sized buffer, as many bytes are
+returned as it fits into it, rest is zeroed).
 .It AT_HWCAP
-CPU / hardware feature flags.
+CPU / hardware feature flags
+.Dv (sizeof(u_long)).
 .It AT_HWCAP2
-CPU / hardware feature flags.
+CPU / hardware feature flags
+.Dv (sizeof(u_long)).
 .It AT_NCPUS
-Number of CPUs.
+Number of CPUs
+.Dv (sizeof(int)).
 .It AT_OSRELDATE
-Kernel OSRELDATE.
+The
+.Dv OSRELDATE
+of the kernel or jail the program is running on
+.Dv (sizeof(int)).
 .It AT_PAGESIZES
-Vector of page sizes.
+Vector of page sizes (arbitrary sized buffer, as many elements of the
+.Dv pagesizes
+array are returned as it fits).
 .It AT_PAGESZ
-Page size in bytes.
+Page size in bytes
+.Dv (sizeof(int)).
 .It AT_TIMEKEEP
-Pointer to VDSO timehands (for library internal use).
+Pointer to VDSO timehands (for library internal use,
+.Dv sizeof(void *)).
 .El
 .Sh RETURN VALUES
 Returns zero on success, or an error number on failure.