[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH] Doc: Add menu for Array Maps section
From: |
Jose E. Marchesi |
Subject: |
Re: [PATCH] Doc: Add menu for Array Maps section |
Date: |
Sat, 18 Apr 2020 14:16:05 +0200 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) |
Hi John.
OK for master.
Thanks!
---
doc/poke.texi | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/doc/poke.texi b/doc/poke.texi
index 12a94287..b7d4d2fc 100644
--- a/doc/poke.texi
+++ b/doc/poke.texi
@@ -7400,7 +7400,16 @@ XXX
Arrays can be mapped in IO space in three different ways, depending on
the characteristics of the type provided to the mapping operator.
+@menu
+* Array maps bounded by number of elements::
+* Array maps bounded by size::
+* Unbounded array maps::
+* Mapped bounds in bounded arrays::
+@end menu
+
+@node Array maps bounded by number of elements
@subsubsection Array maps bounded by number of elements
+
When an array type bounded by number of elements is used in a mapping
operation, the resulting mapped array is also bounded by number of
elements.
@@ -7438,6 +7447,7 @@ Likewise, if a constraint fails while performing the
mapping (while
mapping an array of structs, for example) an exception is raised and
the map is aborted.
+@node Array maps bounded by size
@subsubsection Array maps bounded by size
While dealing with binary formats, it often happens that the number of
@@ -7528,6 +7538,7 @@ Like in mappings bounded by number of elements, if a
constraint fails
while performing the mapping, an exception is raised and the map is
aborted.
+@node Unbounded array maps
@subsubsection Unbounded array maps
We mentioned above that if an end-of-file condition happens while
@@ -7572,6 +7583,7 @@ the blocks, the constraint in the @code{magic} field
will fail and
will delimit the map that way (provided the binary format is well
designed.)
+@node Mapped bounds in bounded arrays
@subsubsection Mapped bounds in bounded arrays
When an array map is bounded, be it by number of elements or by size,