Bring up to date with approved issues as of April 2014.

Signed-off-by: Ron Brender <ron.brender@gmail.com>

Complete revisions to Appendix B regarding new
.debug_macro representation.

Signed-off-by: Ron Brender <ron.brender@gmail.com>

Incorporate changes through March 2014, except for
100909.2 (DW_CALL_call_site) and parts of Appendix B.

refer.py changes:
1) use io.path.join to make OS independent
2) fix handling of DW*MARK names (to act like targets)
3) tweak output to make easier to use

Signed-off-by: Ron Brender <ron.brender@gmail.com>

Changes for 130526.1 (type unit mere)
Signed-off-by: Ron Brender <ron.brender@gmail.com>

Merge branch 'HEAD' of dwarfgit@dwarfstd.org:dwarf-doc.git

Signed-off-by: Ron Brender <ron.brender@gmail.com>

tools/README: Documented refer.py and repeats.py

Fixing two 1-line typos.
latexdoc/generaldescription.tex

This was mentioned on the list a week or two ago.
Fix eliminates a duplicated word pair from the document.
-\addtoindex{mangled names}
-mangled names.
+\addtoindex{mangled names}.

Noticed this when looking at the index entries for mangled
names (we do not want the ! to appear in the body of text).
-\addtoindex{names!mangled}
+\addtoindexx{names!mangled}

tools/README: Added another quick check that finds
 typos in indexing.

tools/README: Finishing up the repeats commentary.

Adding a new command to look for accidental
word repeats.

tools/README: Document use of repeats.py
tools/repeats.py: Looks for repeated words or phrases
tools/testrepeats.txt: Small test case for repeats.py

To get refer.py to work at all these 3 .tex changes
were helpful.

latexdoc/attributesbytag.tex:
The livetarg command has two arguments.

-\livetarg{chap:DECL}
+\livetarg{chap:DECL}{}

latexdoc/generaldescription.tex:
The original split a livelinki over two lines.
Bad for the (rather weak) refer.py parser code.

-&\livelinki{chap:DWATartificialobjectsortypesthat}{Objects or types that are not
-actually declared in the source}{objects or types that are not actually declared i
n the source}  \\
+&\livelinki{chap:DWATartificialobjectsortypesthat}{Objects or types that are not a ctually declared in the source}{objects or types that are not actually declared in the source}  \\

latexdoc/programscope.tex:
The hypertarget command has two arguments.

-\hypertarget{chap:DWATrecursiverecursivepropertyofasubroutine}
+\hypertarget{chap:DWATrecursiverecursivepropertyofasubroutine}{}

tools/refer.py: Now seems to work finding problems.
tools/testrefer.tex: Tweaked the testcase a little.

refer.py: New app, close to working. To identify
  bad links/references.

fileio.py: Minor fix so [ and ] can be parsed properly,
 and so \ not allowed in middle ofnames so \DWa\DWb
 parsed as two names.

testrefer.tex: A small test file for refer.py

examples.tex

-\caption{Fortran multidimentional coarray: source fragment}
+\caption{Fortran multidimensional coarray: source fragment}

datarepresentation.tex

-  \hline \bfseries Visiibility code name&\bfseries Value \\ \hline
+  \hline \bfseries Visibility code name&\bfseries Value \\ \hline

programscope.tex
-\addtoindexx{trampoline (subprogam) entry}
+\addtoindexx{trampoline (subprogram) entry}

Another typo illuminated by the spell
checker.

README:  Added example shell code using pdftotext and spell
to do spelling check.

debugsectionrelationships.tex:
-\DWFORMaddrx, \DWOPaddrx and \DWOPconstx{} contain
+\DWFORMaddrx, \DWOPaddrx{} and \DWOPconstx{} contain

So that the DWOPaddrx does not become 'DW_OP_addrxand'
in the output.

generaldescription.tex  fix spelling: perfom -> perform

otherdebugginginformation.tex: spelling correction.
Changed preceeding to preceding

tools/README: Documented what each .py file does.
tools/refclassfixup.py: Added a comment documenting
   what this code does (it lacked any hint).

Incorporte all changes and approved issued to date.

Signed-off-by: Ron Brender <ron.brender@gmail.com>

Files for 2013-12-18 draft document. This incorporates
all approved changes and review comments to date.

Signed-off-by: Ron Brender <ron.brender@gmail.com>

Update for the November 22, 2013 version of the document.
Included are all approved issues and review comments up to
that date.

Signed-off-by: Ron Brender <ron.brender@gmail.com>

Signed-off-by: Ron Brender <ron.brender@gmail.com>

Signed-off-by: Ron Brender <ron.brender@gmail.com>

Fixup several missing DWnameTARG issues.

Signed-off-by: Ron Brender <ron.brender@gmail.com>

Completed integration and use of new name commands (with generous
help from David Anderson).

Signed-off-by: Ron Brender <ron.brender@gmail.com>

Two additional typos in dwarfnamecmds.tex fixed.

Found a bug in the python dellivelink.py and fixed it. Added a bit to the
testcase in tools to expose the bug.

Found 6 small and obvious typos/omissions in dwarfnames.tex.
Fixed.

When a label has a digit in it dellivelink.py notices
and prints a warning. And for that instance, does not convert
to the new form.
Because digits are not allowed in command names.
The remaining instances should be fixed in the .tex.

Some obvious small fixes to dwarfnamecmds.tex are needed for
things to work. These typos lead to the pdf build getting
an error. We cannot be sure all the typos fixed till we
try removing all the livelink livetarg using dellivelink.py
on all the .tex.

Seemingly dellivelink.py works properly now, though
generating the document with its changes is failing.
So the latex document has none of dellivelink.py changes
applied.

Two lines in dwarfnamecmds.tex had typos. Fixed.

Now tools/dellivelink.py deals with altt
sensibly.

Removed the debug print statements from
 dellivelink.py

This python dellivelink.py removes \livelink and \livetarg
in favor of the new format like \DWOPplus  and so on.
dellivelink.tex is a file used to test the code.

Filled out dwarfnamecmds.tex with the full set of Dwarf name symbols.
Made changes in other files to match a few special cases (eg, for
DW_OP_lit2, _lit11, and the like that do not deserve "full treatment".

Signed-off-by: Ron Brender <ron.brender@gmail.com>

Introduce \newdwfnamecommands command that defines multiple
commands based corresponding to DWARF symbolic names. Make
the most common case, eg, \DWATname, be the form that results
in both an index entry and a live link (that is, reverse the
LL suffix convention introduced in the previous submision.

Signed-off-by: Ron Brender <ron.brender@gmail.com>

Editorial cleanups mostly related to coarrays and assumed rank arrays.

Signed-off-by: Ron Brender <ron.brender@gmail.com>

Merge branch 'master' of dwarfgit@dwarfstd.org:dwarf-doc.git

Prepare for merge...

Signed-off-by: Ron Brender <ron.brender@gmail.com>

Incorporate Issue 130313.5, Add support for Fortran assumed-rank arrays.

Added a make check target to list missing references.

First draft of Version 5, incorporating numerous approved changes
(see new Change Summary in Draft versions).

Signed-off-by: Ron Brender <ron.brender@gmail.com>

dwarf5.tex : Minor change removes an hbox overfull
warning from latex (though lots of them remain).

dataobject.tex: An internal link was misspelled:  chap:class:reference->chap:classreference      latex caught it.

Ron Brender reviewed these changes.

A few miscelleaneous corrections including especially fixing the spacing
around lists using /tight, which is specific to the memoire class (setting
/topsep to zero has no effect).

Signed-off-by: Ron Brender <ron.brender@gmail.com>

Complete work on live links, cleanup some indexing and redo pagination.
This completes all review processing.

Signed-off-by: Ron Brender <ron.brender@gmail.com>

This completes (many!) changes resulting from reviews over the
last several months.

Signed-off-by: Ron Brender <ron.brender@gmail.com>

dataobject.tex had 2 instances of utf8 remaining due
to an oversight earlier.  Now those use the textquoteright
command instead of the utf quote character.
Renamed tools charfix.py and charfix.sh to removeutf8.py and removeutf8.sh
as that is what they really do... remove utf8.  There are no
remaining utf8 instances at the present time.

Using removehyphen.py in tools to do
the actual work, this commit removes all the \-
from DW_ strings in .tex.

attributesbytag.tex
compression.tex
dataobject.tex
datarepresentation.tex
debugsectionrelationships.tex
dwarf5.tex
dwarfnamecmds.tex
examples.tex
generaldescription.tex
introduction.tex
otherdebugginginformation.tex
programscope.tex
typeentries.tex

New script removehyphen.py fixes up the use of \-
by removing them.

Many small updates/corrections in responce to Committee review.

Signed-off-by: Ron Brender <ron.brender@gmail.com>

1) Change to T1 (instead of OT1) font encoding
2) Try out new fonts
3) Redo figure in Appendix B using TikZ
4) Ad hoc ff ligature fixups

Signed-off-by: Ron Brender <ron.brender@gmail.com>

This is the first pass of incorporating review commments from the
March/April review.

Signed-off-by: Ron Brender <ron.brender@gmail.com>

Final cleanups before group review. Only Appendix B Figure is pending...

Signed-off-by: Ron Brender <ron.brender@gmail.com>

Tweak sytle of numbered keyword lists to match that used in Chapter 6
(that is, use bold for the keyword).

[Similar changes are planned for the following Chapters.

Signed-off-by: Ron Brender <ron.brender@gmail.com>

More pagination cleanups using \needspace and \needlines.

Signed-off-by: Ron Brender <ron.brender@gmail.com>

Try out newly discovered needspace package; it is wonderful...

datarepresentation.tex had a utf8 bullet character
still in the text.  Now it is gone.  latex is correctly
placing bullets where they should be, this one was a leftover
from the copy/paste operations which created the .tex.

Removes the utf-8 strings from the .tex files and
replaces with latex commands to do the same job.
All the following had utf-8 in them till now.
Which came from the DWARF4 pdf creation process.
compression.tex datarepresentation.tex examples.tex
foreword4.1.tex generaldescription.tex gnulicense.tex
otherdebugginginformation.tex programscope.tex typeentries.tex

This shell script charfix.sh is good for the one-time
removal of utf-8 characters.
Probably not useful again.

Just fixing charfix.sh to be easier to do in stages.
Not part of the .tex.  aiding utf-8 removal.

Complete figure to table conversion; other cleanups

Merge branch 'master' of dwarfstd.org:dwarf-doc

Change many figures to tables, lots of other fixes

convert sections back to figures in App D and E

Add Mac OS X instructions for building a PDF.

Misc corrections in App B through end

Misc corrections Chpt 6 thru App A

Misc corrections up thru Chpt 5

Index entries for u (you) and other details

These had a handful of spelling errors. None
of the errors are in DWARF4, they were introduced
to 4.1 in index entries, comments, and a couple times
in the text body.
datarepresentation.tex
dwarf5.tex
generaldescription.tex
otherdebugginginformation.tex
programscope.tex
typeentries.tex

Adding to the tools, in the tools directory.
The new tool can fix up  the utf-8 introduced
accidentally by copy/paste into the
current .tex. Changing it into proper latex
commands so all will then look right.

No change to any .tex file in this commit.

Fixing 5 instances of \addtoindex[x] missing its leading backslash.

Removing the small traces of DWARF5 from introduction, foreword, and
copyright chapters.

Indexing letter 't' is complete in this change.

Indexing letter 's'.

Indexing o p q(none present) and r.

Indexing m and n complete.

Indexing l (letter ell).

Indexing i and j is done.

This indexes letters f, g, and h.
It also has additions for DW_AT_high_pc, low_pc, and ranges
that I noticed were incomplete.

Added a note to the document README on 'undefined' references:
They are part of the multi-pass nature of latex and not
always really undefined.

Explaining, in the overall README for latex source, that
the tools directory is not something that most contributors
need to look at.

This adds all the e* index entries present in DW4 into 4.1 latex.

Corrects  verbatim to be alltt in one crucial spot
so an example looks right and its attribute uses
are indexed.
typeentries.tex

compression.tex
datarepresentation.tex
foreword.tex
generaldescription.tex
introduction.tex
otherdebugginginformation.tex
programscope.tex
sectionversionnumbers.tex
typeentries.tex

This completes the d* index entries.
At least a decent first cut at them.

More d* index entries added.

This does indexing of more d* words and phrases.

Index v and other stuff

Try .jpq version of DWlogo

Indexing the b* entries, completed here.
A few "See Section" things were not proper \refersec, fixed thouse.
A few instances of "something" were present and those are now
in latex form ``something'' . Except in examples, where "" is
fine as is.

Finished indexing the a* entries up through
  'beginning of a data member'

  Updated date string in dwarf5.tex.

Fixed  the attributes table in generaldescription.tex so
it uses lower case for indexing where appropriate instead
of the capitals appearing in the table itself.

Indexes more entries starting with a.
Noticed livelink commands in the attributes table result in index entries
starting with capital letters, which was not my intent.
Changed some to livelinki and there are many more to do.
A few of the non-A language name entries were indexed too, though
there is more to do for the other language index entries.

Changes  to add index entries completing all of them up
through 'abstract'.  In 4.1 Latex.
Not quite half of the first page of index entries
done once these committed.

Working through the abstract instance examples it was
natural to do some of the
concrete instance example indexing too.

Explained in READMEindexing how to get < and > characters to print.

This shortens the often-long line of ....
in tools/dw4index.txt  and tools/dw4sortedindex.txt
as we don't need all those dots for anything. They were
an artifact of copy/paste of the DWARF4 pdf index data.

Adds index entries for all .debug_* and a couple other
index entries beginning with '.'.
The section-relationships page was missing .debug_types,
now that name is in its proper place (per the DW4 doc).