This is the mail archive of the
libc-alpha@sourceware.org
mailing list for the glibc project.
[PATCH] Fix section ording warnings in memory.texi with texinfo-5.0
- From: Allan McRae <allan at archlinux dot org>
- To: libc-alpha at sourceware dot org
- Date: Thu, 21 Feb 2013 22:41:04 +1000
- Subject: [PATCH] Fix section ording warnings in memory.texi with texinfo-5.0
- References: <1361450464-20103-1-git-send-email-allan@archlinux.org>
texinfo-5.0 generates ~250 warnings of the form:
warning: node `foo' is prev for `bar' in menu but not in sectioning
These are fixed by explicitly providing the ordering in the @node line
in the form:
@node Name, Next, Previous, Top
---
manual/memory.texi | 28 ++++++++++++++--------------
1 file changed, 14 insertions(+), 14 deletions(-)
Would people prefer one patch with ~250 changes, or this split up by
file (or sets of files for those with only a few changes).
Also, does the changelog need to have detail of every section?
ChangeLog:
2013-02-21 Allan McRae <allan@archlinux.org>
* manual/memory.texi: Fix section ordering warnings with texinfo-5.0.
diff --git a/manual/memory.texi b/manual/memory.texi
index 5b14aa6..0a6ed47 100644
--- a/manual/memory.texi
+++ b/manual/memory.texi
@@ -24,7 +24,7 @@ Memory mapped I/O is not discussed in this chapter. @xref{Memory-mapped I/O}.
-@node Memory Concepts
+@node Memory Concepts, Memory Allocation, , Memory
@section Process Memory Concepts
One of the most basic resources a process has available to it is memory.
@@ -173,7 +173,7 @@ special @theglibc{} and GNU Compiler.
@end menu
-@node Memory Allocation and C
+@node Memory Allocation and C, Unconstrained Allocation, , Memory Allocation
@subsection Memory Allocation in C Programs
The C language supports two kinds of memory allocation through the
@@ -291,7 +291,7 @@ any time (or never).
* Summary of Malloc:: Summary of @code{malloc} and related functions.
@end menu
-@node Basic Allocation
+@node Basic Allocation, Malloc Examples, , Unconstrained Allocation
@subsubsection Basic Memory Allocation
@cindex allocation of memory with @code{malloc}
@@ -1086,7 +1086,7 @@ This function returns information about the current dynamic memory usage
in a structure of type @code{struct mallinfo}.
@end deftypefun
-@node Summary of Malloc
+@node Summary of Malloc, , Statistics of Malloc, Unconstrained Allocation
@subsubsection Summary of @code{malloc}-Related Functions
Here is a summary of the functions that work with @code{malloc}:
@@ -1165,7 +1165,7 @@ penalties for the program if the debugging mode is not enabled.
* Interpreting the traces:: What do all these lines mean?
@end menu
-@node Tracing malloc
+@node Tracing malloc, Using the Memory Debugger, , Allocation Debugging
@subsubsection How to install the tracing functionality
@comment mcheck.h
@@ -1297,7 +1297,7 @@ The output will of course not show the allocations which happened before
the first signal but if there is a memory leak this will show up
nevertheless.
-@node Interpreting the traces
+@node Interpreting the traces, , Tips for the Memory Debugger, Allocation Debugging
@subsubsection Interpreting the traces
If you take a look at the output it will look similar to this:
@@ -1423,7 +1423,7 @@ the padding needed to start each object on a suitable boundary.
* Summary of Obstacks::
@end menu
-@node Creating Obstacks
+@node Creating Obstacks, Preparing for Obstacks, , Obstacks
@subsubsection Creating Obstacks
The utilities for manipulating obstacks are declared in the header
@@ -2069,7 +2069,7 @@ if (obstack_chunk_size (obstack_ptr) < @var{new-chunk-size})
obstack_chunk_size (obstack_ptr) = @var{new-chunk-size};
@end smallexample
-@node Summary of Obstacks
+@node Summary of Obstacks, , Obstack Chunks, Obstacks
@subsubsection Summary of Obstack Functions
Here is a summary of all the functions associated with obstacks. Each
@@ -2150,7 +2150,7 @@ Address just after the end of the currently growing object.
@xref{Status of an Obstack}.
@end table
-@node Variable Size Automatic
+@node Variable Size Automatic, , Obstacks, Memory Allocation
@subsection Automatic Storage with Variable Size
@cindex automatic freeing
@cindex @code{alloca} function
@@ -2193,7 +2193,7 @@ alloca (4), y)}.
freeing automatically.
@end menu
-@node Alloca Example
+@node Alloca Example, Advantages of Alloca, , Variable Size Automatic
@subsubsection @code{alloca} Example
As an example of the use of @code{alloca}, here is a function that opens
@@ -2303,7 +2303,7 @@ portable. However, a slower emulation of @code{alloca} written in C
is available for use on systems with this deficiency.
@end itemize
-@node GNU C Variable-Size Arrays
+@node GNU C Variable-Size Arrays, , Disadvantages of Alloca, Variable Size Automatic
@subsubsection GNU C Variable-Size Arrays
@cindex variable-sized arrays
@@ -2408,7 +2408,7 @@ of the data segment is.
-@node Locking Pages
+@node Locking Pages, , Resizing the Data Segment, Memory
@section Locking Pages
@cindex locking pages
@cindex memory lock
@@ -2430,7 +2430,7 @@ pages.
* Page Lock Functions:: Here's how to do it.
@end menu
-@node Why Lock Pages
+@node Why Lock Pages, Locked Memory Details, , Locking Pages
@subsection Why Lock Pages
Because page faults cause paged out pages to be paged in transparently,
@@ -2515,7 +2515,7 @@ enter a scope that declares a C automatic variable larger than the
maximum stack size you will need, set it to something, then return from
its scope.
-@node Page Lock Functions
+@node Page Lock Functions, , Locked Memory Details, Locking Pages
@subsection Functions To Lock And Unlock Pages
The symbols in this section are declared in @file{sys/mman.h}. These
--
1.8.1.4