+2014-06-06 Jonathan Wakely <jwakely@redhat.com>
+
+ * doc/xml/faq.xml (faq.stream_reopening_fails): Replace <quote> in
+ code example.
+ * doc/xml/manual/backwards_compatibility.xml
+ (backwards.second.stringstreams): Likewise.
+ * doc/xml/manual/configure.xml (--enable-libstdcxx-time): Document
+ change of default.
+ * doc/xml/manual/containers.xml (associative.bitset.type_string):
+ Replace <quote> in code example.
+ * doc/xml/manual/debug.xml: Clarify reference to ThreadSanitizer.
+ * doc/xml/manual/documentation_hacking.xml: Improve debugging tips,
+ fix typos, improve markup.
+ * doc/xml/manual/intro.xml (manual.intro.status.bugs.iso): Replace
+ <emphasis> with <replaceable>.
+ * doc/xml/manual/locale.xml (locale.impl.c): Remove backticks.
+ * doc/xml/manual/support.xml (std.support.memory): Replace <quote>
+ and remove newlines in string literal.
+
2014-06-03 Paolo Carlini <paolo.carlini@oracle.com>
DR 1423
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.graphviz.org">Graphviz</link> package
will need to be installed. For PDF
output, <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.tug.org/applications/pdftex/">
- pdflatex</link> is required.
+ pdflatex</link> is required as well as a number of TeX packages
+ such as <package>texlive-xtab</package> and
+ <package>texlive-tocloft</package>.
</para>
<para>
</para>
<para>
Working on the doxygen path only, closely examine the
- contents of the following build directory:
- <filename>build/target/libstdc++-v3/doc/doxygen/latex</filename>.
+ contents of the following build directory: <filename
+ class="directory">build/target/libstdc++-v3/doc/doxygen/latex</filename>.
Pay attention to three files enclosed within, annotated as follows.
</para>
<itemizedlist>
The actual latex file, or partial latex file. This is generated
via <command>doxygen</command>, and is the LaTeX version of the
Doxygen XML file <filename>libstdc++-api.xml</filename>. Go to a specific
- line, and look at the genrated LaTeX, and try to deduce what
+ line, and look at the generated LaTeX, and try to deduce what
markup in <filename>libstdc++-api.xml</filename> is causing it.
</para>
</listitem>
+<listitem>
+ <para>
+ <emphasis>refman.log</emphasis>
+ </para>
+
+ <para>
+ A log created by <command>latex</command> as it processes the
+ <filename>refman.tex</filename> file. If generating the PDF fails
+ look at the end of this file for errors such as:
+ <screen>
+ ! LaTeX Error: File `xtab.sty' not found.
+ </screen>
+ This indicates a required TeX package is missing. For the example
+ above the <package>texlive-xtab</package> package needs to be
+ installed.
+ </para>
+</listitem>
+
<listitem>
<para>
<emphasis>refman.out</emphasis>
</para>
<para>
- A log of the compilation of the converted LaTeX form to pdf. This
+ A log of the compilation of the converted LaTeX form to PDF. This
is a linear list, from the beginning of the
<filename>refman.tex</filename> file: the last entry of this file
should be the end of the LaTeX file. If it is truncated, then you
<classname>deque</classname>/<classname>vector</classname>/<classname>list</classname>
and <classname>std::pair</classname> as examples. For
functions, see their member functions, and the free functions
- in <filename>stl_algobase.h</filename>. Member functions of
- other container-like types should read similarly to these
- member functions.
+ in <filename class="headerfile">stl_algobase.h</filename>. Member
+ functions of other container-like types should read similarly to
+ these member functions.
</para>
<para>
<para>
Use either kind of grouping, as
appropriate. <filename>doxygroups.cc</filename> exists for this
- purpose. See <filename>stl_iterator.h</filename> for a good example
- of the <quote>other</quote> kind of grouping.
+ purpose. See <filename class="headerfile">stl_iterator.h</filename>
+ for a good example of the <quote>other</quote> kind of grouping.
</para>
<para>
</para>
<para>
- Complicated math functions should use the multi-line
- format. An example from <filename>random.h</filename>:
+ Complicated math functions should use the multi-line format.
+ An example from <filename class="headerfile">random.h</filename>:
</para>
<para>
<para>
The other relevant detail for header files is the use of a
libstdc++-specific doxygen alias that helps distinguish
- between public header files (like <filename>random</filename>)
+ between public header files (like <filename class="headerfile">random</filename>)
from implementation or private header files (like
- <filename>bits/c++config.h</filename>.) This alias is spelled
+ <filename class="headerfile">bits/c++config.h</filename>.) This alias is spelled
<literal>@headername</literal> and can take one or two
arguments that detail the public header file or files that
should be included to use the contents of the file. All header
<para>
Working on the docbook path only, closely examine the
contents of the following build directory:
- <filename>build/target/libstdc++-v3/doc/docbook/latex</filename>.
+ <filename class="directory">build/target/libstdc++-v3/doc/docbook/latex</filename>.
Pay attention to three files enclosed within, annotated as follows.
</para>
The actual latex file, or partial latex file. This is generated
via <command>dblatex</command>, and is the LaTeX version of the
DocBook XML file <filename>spine.xml</filename>. Go to a specific
- line, and look at the genrated LaTeX, and try to deduce what
+ line, and look at the generated LaTeX, and try to deduce what
markup in <filename>spine.xml</filename> is causing it.
</para>
</listitem>
git://gcc.gnu.org / gcc.git / commitdiff