Indexing o p q(none present) and r.
[dwarf-doc.git] / dwarf5 / latexdoc / generaldescription.tex
index 1a1f02f..3e77f8c 100644 (file)
@@ -360,7 +360,7 @@ actually declared in the source}{objects or types that are not actually declared
 \livetarg{chap:DWATuseUTF8}{DW\-\_AT\-\_use\-\_UTF8}
 &\livelinki{chap:DWATuseUTF8compilationunitusesutf8strings}{Compilation unit uses UTF-8 strings}{compilation unit uses UTF-8 strings} \\
 \livetarg{chap:DWATvariableparameter}{DW\-\_AT\-\_variable\-\_parameter}
-&\livelink{chap:DWATvariableparameternonconstantparameterflag}{Non-constant parameter flag}{non-constant parameter flag}  \\
+&\livelinki{chap:DWATvariableparameternonconstantparameterflag}{Non-constant parameter flag}{non-constant parameter flag}  \\
 \livetarg{chap:DWATvirtuality}{DW\-\_AT\-\_virtuality}
 &\livelinki{chap:DWATvirtualityvirtualityindication}{Virtuality indication}{virtuality indication} \\
 &\livelinki{chap:DWATvirtualityvirtualityofbaseclass}{Virtuality of base class} {virtuality of base class} \\
@@ -1127,7 +1127,9 @@ contiguous piece or all of an object or value.
 
 A 
 \addtoindexx{location description!memory}
-memory location description consists of a non\dash empty DWARF
+memory location description 
+\addtoindexx{memory location description}
+consists of a non\dash empty DWARF
 expression (see 
 Section \refersec{chap:dwarfexpressions}
 ), whose value is the address of
@@ -1466,7 +1468,7 @@ entry includes a location description.
 \textit{A base address selection entry and an end of list
 entry for a location list are identical to a base address
 selection entry and end of list entry, respectively, for a
-range list 
+\addtoindex{range list}
 (see Section \refersec{chap:noncontiguousaddressranges}) 
 in interpretation
 and representation.}
@@ -1528,7 +1530,7 @@ value is a constant drawn from the set of codes listed in Figure
 \section{Visibility of Declarations}
 \label{chap:visibilityofdeclarations}
 
-\textit{Several languages (such as Modula-2
+\textit{Several languages (such as \addtoindex{Modula-2}
 have the concept of the visibility of a declaration. The
 visibility specifies which declarations are to be 
 visible outside of the entity in which they are
@@ -1804,10 +1806,14 @@ Any
 \hypertarget{chap:DWATnamenameofdeclaration}
 debugging information entry 
 \addtoindexx{identifier names}
-representing a program entity
+representing 
+\addtoindexx{names!identifier}
+a program entity
 that has been given a name may have a 
 \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute,
-whose value is a string representing the name as it appears in
+whose 
+\addtoindexx{name attribute}
+value is a string representing the name as it appears in
 the source program. A debugging information entry containing
 no name attribute, or containing a name attribute whose value
 consists of a name containing a single null byte, represents
@@ -1816,12 +1822,18 @@ a program entity for which no name was given in the source.
 \textit{Because the names of program objects described by DWARF are the
 names as they appear in the source program, implementations
 of language translators that use some form of mangled name
+\addtoindex{mangled names}
 (as do many implementations of C++) should use the unmangled
-form of the name in the DWARF \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute,
+form of the name in the 
+DWARF \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute,
+\addtoindexx{name attribute}
 including the keyword operator (in names such as “operator
 +”), if present. See also 
 Section \refersec{chap:linkagenames} regarding the use
-of \livelink{chap:DWATlinkagename}{DW\-\_AT\-\_linkage\-\_name} for mangled names. Sequences of
+of \livelink{chap:DWATlinkagename}{DW\-\_AT\-\_linkage\-\_name} for 
+\addtoindex{mangled names}
+mangled names. 
+Sequences of
 multiple whitespace characters may be compressed.}
 
 \section{Data Locations and DWARF Procedures}
@@ -1939,50 +1951,59 @@ attributes should be produced.
 \subsection{Non\dash Contiguous Address Ranges}
 \label{chap:noncontiguousaddressranges}
 When the set of addresses of a debugging information entry
+\addtoindexx{non-contiguous address ranges}
 cannot be described as a single contiguous range, the entry has
 a \livelink{chap:DWATranges}{DW\-\_AT\-\_ranges} attribute 
 \addtoindexx{ranges attribute}
 whose value is of class \livelink{chap:rangelistptr}{rangelistptr}
-and indicates the beginning of a range list. Similarly,
+and indicates the beginning of a \addtoindex{range list}.
+Similarly,
 a \livelink{chap:DWATstartscope}{DW\-\_AT\-\_start\-\_scope} attribute may have a value of class
 \livelink{chap:rangelistptr}{rangelistptr} for the same reason.  
 
 Range lists are contained
 in a separate object file section called 
 \addtoindex{.debug\_ranges}. A
-range list is indicated by a 
+\addtoindex{range list} is indicated by a 
 \livelink{chap:DWATranges}{DW\-\_AT\-\_ranges} attribute whose
 \addtoindexx{ranges attribute}
 value is represented as an offset from the beginning of the
-\addtoindex{.debug\_ranges} section to the beginning of the range list.
+\addtoindex{.debug\_ranges} section to the beginning of the 
+\addtoindex{range list}.
 
-Each entry in a range list is either a range list entry,
+Each entry in a \addtoindex{range list} is either a 
+\addtoindex{range list} entry,
 \addtoindexx{base address selection entry!in range list}
 a base address selection entry, or an 
 \addtoindexx{end of list entry!in range list}
 end of list entry.
 
-A range list entry consists of:
+A \addtoindex{range list} entry consists of:
 
 \begin{enumerate}[1]
 \item A beginning address offset. This address offset has the size of an address and is relative to
-the applicable base address of the compilation unit referencing this range list. It marks the
+the applicable base address of the compilation unit referencing this 
+\addtoindex{range list}. 
+It marks the
 beginning of an 
 \addtoindexi{address}{address range!in range list} 
 range.
 
 \item An ending address offset. This address offset again has the size of an address and is relative
-to the applicable base address of the compilation unit referencing this range list. It marks the
+to the applicable base address of the compilation unit referencing 
+this \addtoindex{range list}.
+It marks the
 first address past the end of the address range.
 The ending address must be greater than or
 equal to the beginning address.
 
-\textit{A range list entry (but not a base address selection or end of list entry) whose beginning and
+\textit{A \addtoindex{range list} entry (but not a base address selection or end of list entry) whose beginning and
 ending addresses are equal has no effect because the size of the range covered by such an
 entry is zero.}
 \end{enumerate}
 
-The applicable base address of a range list entry is determined
+The applicable base address of a \addtoindex{range list} entry
+is determined
 by the closest preceding base address selection entry (see
 below) in the same range list. If there is no such selection
 entry, then the applicable base address defaults to the base
@@ -1994,7 +2015,8 @@ code is contained in a single contiguous section, no base
 address selection entry is needed.}
 
 Address range entries in
-a range list may not overlap. There is no requirement that
+a \addtoindex{range list} may not overlap.
+There is no requirement that
 the entries be ordered in any particular way.
 
 A base address selection entry consists of:
@@ -2010,18 +2032,20 @@ and ending address offsets of subsequent entries of the location list.
 affects only the list in which it is contained.}
 
 
-The end of any given range list is marked by an 
+The end of any given \addtoindex{range list} is marked by an 
 \addtoindexx{end of list entry!in range list}
 end of list entry, 
 which consists of a 0 for the beginning address
-offset and a 0 for the ending address offset. A range list
+offset and a 0 for the ending address offset. 
+A \addtoindex{range list}
 containing only an end of list entry describes an empty scope
 (which contains no instructions).
 
 \textit{A base address selection entry and an 
 \addtoindexx{end of list entry!in range list}
 end of list entry for
-a range list are identical to a base address selection entry
+a \addtoindex{range list} 
+are identical to a base address selection entry
 and end of list entry, respectively, for a location list
 (see Section \refersec{chap:locationlists}) 
 in interpretation and representation.}
@@ -2105,7 +2129,9 @@ type descriptions of the form typename’Class, and
 Generally, any debugging information
 entry that 
 \hypertarget{chap:DWATdescriptionartificialnameordescription}
-has, or may have, a 
+has, or may have, 
+\addtoindexx{name attribute}
+a 
 \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute, may
 also have 
 \addtoindexx{description attribute}
@@ -2144,7 +2170,11 @@ languages,
 make use of implementation defined names within
 object files that are different from the identifier names
 (see Section \refersec{chap:identifiernames}) of entities as they appear in the
-source. Such names, sometimes known as mangled names,
+source. Such names, sometimes known 
+\addtoindex{names!mangled}
+as 
+\addtoindexx{mangled names}
+mangled names,
 are used in various ways, such as: to encode additional
 information about an entity, to distinguish multiple entities
 that have the same name, and so on. When an entity has an