path: root/manual/memory.texi
diff options
authorRical Jasan <ricaljasan@pacific.net>2016-12-21 01:36:58 -0800
committerRical Jasan <ricaljasan@pacific.net>2016-12-21 01:36:58 -0800
commit2fe82ca6dc5a2d2ffc91b7df9d136de7bf10bd9a (patch)
tree9bc8f8d16e9de019dc03e46ab994f9f94005b5ca /manual/memory.texi
parent41c67149b94676347b0068a902058f130e3e88e6 (diff)
manual: Convert @tables of variables to @vtables.
Texinfo @vindex commands add entries to the Variable and Constant Macro Index. Similarly, @items in @vtables are automatically indexed. A number of @tables exist where all @items are @vindexed or all @items are variables, but not indexed, suggesting an optimization by converting such @tables to @vtables and dropping the @vindex. Using a @vtable provides a context for processing @items whereby it can be known the @items should have header and standards annotations. This commit converts @tables of such @items to @vtables in order to establish a framework for automated processing. A pleasant consequence of these changes is that @items previously lacking a @vindex are present in the Variable and Constant Macro Index now. @vindex entries previously detected by summary.awk will still be detected as @items with appropriate annotations. The @vtable of the NSS databases is converted to a @table because 1) those @items are not variables (and will no longer appear in the Variable and Constant Macro Index) and 2) they do not need header and standards annotations, so the incorrect context is fixed. * manual/nss.texi: Change incorrect @vtable to @table. * manual/arith.texi: Convert @tables of variables to @vtables and remove unnecessary indexing. * manual/filesys.texi: Likewise. * manual/llio.texi: Likewise. * manual/memory.texi: Likewise. * manual/process.texi: Likewise. * manual/resource.texi: Likewise. * manual/search.texi: Likewise. * manual/signal.texi: Likewise. * manual/socket.texi: Likewise. * manual/stdio.texi: Likewise. * manual/sysinfo.texi: Likewise. * manual/syslog.texi: Likewise. * manual/terminal.texi: Likewise. * manual/time.texi: Likewise. * manual/users.texi: Likewise.
Diffstat (limited to 'manual/memory.texi')
1 files changed, 4 insertions, 4 deletions
diff --git a/manual/memory.texi b/manual/memory.texi
index b66de602106..38d3c3a4bb4 100644
--- a/manual/memory.texi
+++ b/manual/memory.texi
@@ -1090,8 +1090,8 @@ When calling @code{mallopt}, the @var{param} argument specifies the
parameter to be set, and @var{value} the new value to be set. Possible
choices for @var{param}, as defined in @file{malloc.h}, are:
-@table @code
@comment TODO: @item M_CHECK_ACTION
+@vtable @code
@item M_MMAP_MAX
The maximum number of chunks to allocate with @code{mmap}. Setting this
to zero disables all use of @code{mmap}.
@@ -1177,7 +1177,7 @@ derived from the default value of M_ARENA_TEST and is computed independently.
This parameter can also be set for the process at startup by setting the
environment variable @env{MALLOC_ARENA_MAX} to the desired value.
-@end table
+@end vtable
@end deftypefun
@@ -3213,7 +3213,7 @@ user space kernel data, shared memory, and memory mapped files.
macros. They tell @code{mlockall} which of its functions you want. All
other bits must be zero.
-@table @code
+@vtable @code
Lock all pages which currently exist in the calling process' virtual
@@ -3226,7 +3226,7 @@ affect future address spaces owned by the same process so exec, which
replaces a process' address space, wipes out @code{MCL_FUTURE}.
@xref{Executing a File}.
-@end table
+@end vtable
When the function returns successfully, and you specified
@code{MCL_CURRENT}, all of the process' pages are backed by (connected