Commit d2b0caaa by Benjamin Kosnik Committed by Benjamin Kosnik

appendix_porting.xml: Add doc section.

2011-02-08  Benjamin Kosnik  <bkoz@redhat.com>

	* doc/xml/manual/appendix_porting.xml: Add doc section.
	* doc/xml/manual/appendix_contributing.xml: Split out doc bits to...
	* doc/xml/manual/documentation_hacking.xml: ...here.

	* doc/xml/manual/debug_mode.xml: Adjust.
	* doc/xml/manual/prerequisites.xml: Adjust.
	* doc/Makefile.am (xml_sources): Add dot files,
	documentation_hacking.xml.
	* doc/Makefile.in: Regenerate.

	* doc/xml/manual/build_hacking.xml: Use absolute paths for images.
	* doc/xml/images/confdeps.pdf: Add.

From-SVN: r169932
parent 9b548472
2011-02-08 Benjamin Kosnik <bkoz@redhat.com>
* doc/xml/manual/appendix_porting.xml: Add doc section.
* doc/xml/manual/appendix_contributing.xml: Split out doc bits to...
* doc/xml/manual/documentation_hacking.xml: ...here.
* doc/xml/manual/debug_mode.xml: Adjust.
* doc/xml/manual/prerequisites.xml: Adjust.
* doc/Makefile.am (xml_sources): Add dot files,
documentation_hacking.xml.
* doc/Makefile.in: Regenerate.
* doc/xml/manual/build_hacking.xml: Use absolute paths for images.
* doc/xml/images/confdeps.pdf: Add.
2011-02-08 Jonathan Wakely <jwakely.gcc@gmail.com> 2011-02-08 Jonathan Wakely <jwakely.gcc@gmail.com>
* doc/xml/gnu/fdl-1.2.xml: Remove. * doc/xml/gnu/fdl-1.2.xml: Remove.
......
## Makefile for the doc subdirectory of the GNU C++ Standard library. ## Makefile for the doc subdirectory of the GNU C++ Standard library.
## ##
## Copyright (C) 2008, 2009, 2010 Free Software Foundation, Inc. ## Copyright (C) 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
## ##
## This file is part of the libstdc++ version 3 distribution. ## This file is part of the libstdc++ version 3 distribution.
## Process this file with automake to produce Makefile.in. ## Process this file with automake to produce Makefile.in.
...@@ -318,6 +318,7 @@ xml_sources_manual = \ ...@@ -318,6 +318,7 @@ xml_sources_manual = \
${xml_dir}/manual/debug_mode.xml \ ${xml_dir}/manual/debug_mode.xml \
${xml_dir}/manual/debug.xml \ ${xml_dir}/manual/debug.xml \
${xml_dir}/manual/diagnostics.xml \ ${xml_dir}/manual/diagnostics.xml \
${xml_dir}/manual/documentation_hacking.xml \
${xml_dir}/manual/evolution.xml \ ${xml_dir}/manual/evolution.xml \
${xml_dir}/manual/extensions.xml \ ${xml_dir}/manual/extensions.xml \
${xml_dir}/manual/internals.xml \ ${xml_dir}/manual/internals.xml \
...@@ -360,7 +361,10 @@ xml_sources = \ ...@@ -360,7 +361,10 @@ xml_sources = \
xml_noinst = \ xml_noinst = \
${xml_dir}/book.txml \ ${xml_dir}/book.txml \
${xml_dir}/chapter.txml \ ${xml_dir}/chapter.txml \
${xml_dir}/class.txml ${xml_dir}/class.txml \
${xml_dir}/images/confdeps.dot \
${xml_dir}/images/confdeps.png \
${xml_dir}/images/confdeps.pdf
XSLTPROC = xsltproc XSLTPROC = xsltproc
XSLTPROC_FLAGS = --nonet --xinclude XSLTPROC_FLAGS = --nonet --xinclude
......
...@@ -369,6 +369,7 @@ xml_sources_manual = \ ...@@ -369,6 +369,7 @@ xml_sources_manual = \
${xml_dir}/manual/debug_mode.xml \ ${xml_dir}/manual/debug_mode.xml \
${xml_dir}/manual/debug.xml \ ${xml_dir}/manual/debug.xml \
${xml_dir}/manual/diagnostics.xml \ ${xml_dir}/manual/diagnostics.xml \
${xml_dir}/manual/documentation_hacking.xml \
${xml_dir}/manual/evolution.xml \ ${xml_dir}/manual/evolution.xml \
${xml_dir}/manual/extensions.xml \ ${xml_dir}/manual/extensions.xml \
${xml_dir}/manual/internals.xml \ ${xml_dir}/manual/internals.xml \
...@@ -411,7 +412,10 @@ xml_sources = \ ...@@ -411,7 +412,10 @@ xml_sources = \
xml_noinst = \ xml_noinst = \
${xml_dir}/book.txml \ ${xml_dir}/book.txml \
${xml_dir}/chapter.txml \ ${xml_dir}/chapter.txml \
${xml_dir}/class.txml ${xml_dir}/class.txml \
${xml_dir}/images/confdeps.dot \
${xml_dir}/images/confdeps.png \
${xml_dir}/images/confdeps.pdf
XSLTPROC_FLAGS = --nonet --xinclude XSLTPROC_FLAGS = --nonet --xinclude
#XSL_STYLE_DIR = /usr/share/sgml/docbook/xsl-stylesheets #XSL_STYLE_DIR = /usr/share/sgml/docbook/xsl-stylesheets
......
...@@ -19,12 +19,14 @@ ...@@ -19,12 +19,14 @@
</keywordset> </keywordset>
</info> </info>
<!-- Hacking the Build System --> <!-- Hacking the Build System -->
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="xml" href="build_hacking.xml"> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="xml" href="build_hacking.xml">
</xi:include> </xi:include>
<!-- Hacking the Documentation Systems -->
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="xml" href="documentation_hacking.xml">
</xi:include>
<!-- Internals: Porting to New Hardware or Operating Systems --> <!-- Internals: Porting to New Hardware or Operating Systems -->
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="xml" href="internals.xml"> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="xml" href="internals.xml">
</xi:include> </xi:include>
......
<section xmlns="http://docbook.org/ns/docbook" version="5.0" <section xmlns="http://docbook.org/ns/docbook" version="5.0"
xml:id="appendix.porting.build_hacking" xreflabel="Build Hacking"> xml:id="appendix.porting.build_hacking" xreflabel="Build Hacking">
<?dbhtml filename="build_hacking.html"?> <?dbhtml filename="build_hacking.html"?>
...@@ -22,10 +22,8 @@ ...@@ -22,10 +22,8 @@
</keywordset> </keywordset>
</info> </info>
<section xml:id="build_hacking.prereq"><info><title>Prerequisites</title></info> <section xml:id="build_hacking.prereq"><info><title>Prerequisites</title></info>
<para> <para>
As noted <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/install/prerequisites.html">previously</link>, As noted <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/install/prerequisites.html">previously</link>,
certain other tools are necessary for hacking on files that certain other tools are necessary for hacking on files that
...@@ -41,18 +39,22 @@ ...@@ -41,18 +39,22 @@
</section> </section>
<section xml:id="build_hacking.map"><info><title>Overview: What Comes from Where</title></info> <section xml:id="build_hacking.map"><info><title>Overview: What Comes from Where</title></info>
<screen>
<inlinemediaobject> <figure>
<title>Configure and Build File Dependencies</title>
<mediaobject>
<imageobject>
<imagedata align="center" format="PDF" fileref="/mnt/share/src/gcc.svn-trunk/libstdc++-v3/doc/xml/images/confdeps.pdf"/>
</imageobject>
<imageobject> <imageobject>
<imagedata fileref="images/confdeps.png"/> <imagedata align="center" format="PNG" fileref="/mnt/share/src/gcc.svn-trunk/libstdc++-v3/doc/xml/images/confdeps.png"/>
</imageobject> </imageobject>
<textobject> <textobject>
<phrase>Dependency Graph Configure to Build Files</phrase> <phrase>Dependency Graph for Configure and Build Files</phrase>
</textobject> </textobject>
</inlinemediaobject> </mediaobject>
</screen> </figure>
<para> <para>
Regenerate all generated files by using the command sequence Regenerate all generated files by using the command sequence
...@@ -68,7 +70,7 @@ ...@@ -68,7 +70,7 @@
</section> </section>
<section xml:id="build_hacking.scripts"><info><title>Storing Information in non-AC files (like configure.host)</title></info> <section xml:id="build_hacking.scripts"><info><title>Storing Information in non-AC files (like configure.host)</title></info>
<para> <para>
Until that glorious day when we can use AC_TRY_LINK with a Until that glorious day when we can use AC_TRY_LINK with a
...@@ -100,7 +102,7 @@ ...@@ -100,7 +102,7 @@
</section> </section>
<section xml:id="build_hacking.conventions"><info><title>Coding and Commenting Conventions</title></info> <section xml:id="build_hacking.conventions"><info><title>Coding and Commenting Conventions</title></info>
<para> <para>
Most comments should use {octothorpes, shibboleths, hash marks, Most comments should use {octothorpes, shibboleths, hash marks,
...@@ -125,7 +127,7 @@ ...@@ -125,7 +127,7 @@
</section> </section>
<section xml:id="build_hacking.acinclude"><info><title>The acinclude.m4 layout</title></info> <section xml:id="build_hacking.acinclude"><info><title>The acinclude.m4 layout</title></info>
<para> <para>
The nice thing about acinclude.m4/aclocal.m4 is that macros aren't The nice thing about acinclude.m4/aclocal.m4 is that macros aren't
actually performed/called/expanded/whatever here, just loaded. So actually performed/called/expanded/whatever here, just loaded. So
...@@ -216,7 +218,7 @@ ...@@ -216,7 +218,7 @@
</section> </section>
<section xml:id="build_hacking.enable"><info><title><constant>GLIBCXX_ENABLE</constant>, the <literal>--enable</literal> maker</title></info> <section xml:id="build_hacking.enable"><info><title><constant>GLIBCXX_ENABLE</constant>, the <literal>--enable</literal> maker</title></info>
<para> <para>
All the GLIBCXX_ENABLE_FOO macros use a common helper, All the GLIBCXX_ENABLE_FOO macros use a common helper,
......
...@@ -627,7 +627,7 @@ namespace std ...@@ -627,7 +627,7 @@ namespace std
</programlisting> </programlisting>
<para>In debug mode we include the release-mode container (which is now <para>In debug mode we include the release-mode container (which is now
defined in the namespace <code>__norm</code>) and also the defined in the namespace <code>__cxx1998</code>) and also the
debug-mode container. The debug-mode container is defined within the debug-mode container. The debug-mode container is defined within the
namespace <code>__debug</code>, which is associated with namespace namespace <code>__debug</code>, which is associated with namespace
<code>std</code> via the C++0x namespace association language feature. This <code>std</code> via the C++0x namespace association language feature. This
...@@ -639,7 +639,7 @@ to C++ code as follows:</para> ...@@ -639,7 +639,7 @@ to C++ code as follows:</para>
<programlisting> <programlisting>
namespace std namespace std
{ {
namespace __norm namespace __cxx1998
{ {
template&lt;typename _Tp, typename _Alloc = allocator&lt;_Tp&gt; &gt; template&lt;typename _Tp, typename _Alloc = allocator&lt;_Tp&gt; &gt;
class list class list
...@@ -652,12 +652,12 @@ namespace std ...@@ -652,12 +652,12 @@ namespace std
{ {
template&lt;typename _Tp, typename _Alloc = allocator&lt;_Tp&gt; &gt; template&lt;typename _Tp, typename _Alloc = allocator&lt;_Tp&gt; &gt;
class list class list
: public __norm::list&lt;_Tp, _Alloc&gt;, : public __cxx1998::list&lt;_Tp, _Alloc&gt;,
public __gnu_debug::_Safe_sequence&lt;list&lt;_Tp, _Alloc&gt; &gt; public __gnu_debug::_Safe_sequence&lt;list&lt;_Tp, _Alloc&gt; &gt;
{ {
// ... // ...
}; };
} // namespace __norm } // namespace __cxx1998
// namespace __debug __attribute__ ((strong)); // namespace __debug __attribute__ ((strong));
inline namespace __debug { } inline namespace __debug { }
......
...@@ -43,8 +43,8 @@ ...@@ -43,8 +43,8 @@
<para> <para>
To generate the API documentation from the sources you will need To generate the API documentation from the sources you will need
Doxygen, see <link linkend="contrib.doc_style">Documentation Doxygen, see <link linkend="appendix.porting.doc">Documentation
Style</link> in the appendix for full details. Hacking</link> in the appendix for full details.
</para> </para>
<para> <para>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment