diff mbox

[v3] docbook vs. texlive > 2007

Message ID CAH6eHdRyDkGgVM_seCzLoaQgRT=0BSrB5AHom_8S4YjtjP5NXA@mail.gmail.com
State New
Headers show

Commit Message

Jonathan Wakely Dec. 18, 2012, 11:08 a.m. UTC
On 11 December 2012 02:14, Benjamin De Kosnik wrote:
>
> The recent change in Fedora's documentation stack, from texlive-2007 to
> texlive-2013 caused some havoc in the libstdc++ "make pdf" rules.
>
> This patch fixes the previously unknown issues so that the pdf docs for
> libstdc++ can be built on texlive-2007 and texlive-2013.

This patch broke html generation for me. The new file containing the
bibliography didn't have an xmlns attribute on the root node, so the
<bibliography> element wasn't processed correctly.

This fixes it, however the Bibliography still appears after the first
section in the Policy Based Data Structures chapter, rather than the
last, because the <bibliography> element doesn't start a new chunk so
is in the same file as the first section. Adding a <?dbhtml?> PI
doesn't have seem to have any effect on a <bibliography>.

This patch also adds <?dbhtml?> PIs to several sections so the HTML
pages get stable names, rather than something like
bk01pt03ch20s05.html

        * doc/xml/manual/abi.xml: Update URLs for C++ ABI.
        * doc/xml/manual/policy_data_structures_biblio.xml: Add xmlns
        attribute.
        * doc/xml/manual/debug_mode.xml: Give filenames to chunks.
        * doc/xml/manual/diagnostics.xml: Likewise.
        * doc/xml/manual/extensions.xml: Likewise.
        * doc/xml/manual/bitmap_allocator.xml: Likewise.
        * doc/xml/manual/mt_allocator.xml: Likewise.
        * doc/xml/manual/policy_data_structures.xml: Likewise.
        * doc/xml/manual/parallel_mode.xml: Likewise.
        * doc/xml/manual/profile_mode.xml: Likewise.
        * doc/xml/manual/spine.xml: Likewise. Update copyright years.
        * doc/html/*: Regenerate.

Committed to trunk.  I'll fix the ABI URLs and check the html gen on
the 4.7 branch too.
commit b5e4659a8addd90789ca648277a99ad643a45ff7
Author: Jonathan Wakely <jwakely.gcc@gmail.com>
Date:   Sat Dec 15 00:06:11 2012 +0000

    	* doc/xml/manual/abi.xml: Update URLs for C++ ABI.
    	* doc/xml/manual/policy_data_structures_biblio.xml: Add xmlns
    	attribute.
    	* doc/xml/manual/debug_mode.xml: Give filenames to chunks.
    	* doc/xml/manual/diagnostics.xml: Likewise.
    	* doc/xml/manual/extensions.xml: Likewise.
    	* doc/xml/manual/bitmap_allocator.xml: Likewise.
    	* doc/xml/manual/mt_allocator.xml: Likewise.
    	* doc/xml/manual/policy_data_structures.xml: Likewise.
    	* doc/xml/manual/parallel_mode.xml: Likewise.
    	* doc/xml/manual/profile_mode.xml: Likewise.
    	* doc/xml/manual/spine.xml: Likewise. Update copyright years.
    	* doc/html/*: Regenerate.

Comments

Benjamin Kosnik Dec. 19, 2012, 7:12 p.m. UTC | #1
> > This patch fixes the previously unknown issues so that the pdf docs
> > for libstdc++ can be built on texlive-2007 and texlive-2013.
> 
> This patch broke html generation for me. The new file containing the
> bibliography didn't have an xmlns attribute on the root node, so the
> <bibliography> element wasn't processed correctly.

Ugh. Sorry. I was paying a lot more attention to pdf for this round.

> This fixes it, however the Bibliography still appears after the first
> section in the Policy Based Data Structures chapter, rather than the
> last, because the <bibliography> element doesn't start a new chunk so
> is in the same file as the first section. Adding a <?dbhtml?> PI
> doesn't have seem to have any effect on a <bibliography>.

Yeah, I'm wondering if a single biblio for the entire manual might make
more sense. There are a lot of repetitions.

> This patch also adds <?dbhtml?> PIs to several sections so the HTML
> pages get stable names, rather than something like
> bk01pt03ch20s05.html

Sounds good.

> Committed to trunk.  I'll fix the ABI URLs and check the html gen on
> the 4.7 branch too.

Thanks.

-benjamin
diff mbox

Patch

diff --git a/libstdc++-v3/doc/xml/manual/abi.xml b/libstdc++-v3/doc/xml/manual/abi.xml
index 23c6355..9d7395e 100644
--- a/libstdc++-v3/doc/xml/manual/abi.xml
+++ b/libstdc++-v3/doc/xml/manual/abi.xml
@@ -42,7 +42,7 @@ 
   virtual functions, etc. These details are defined as the compiler
   Application Binary Interface, or ABI. The GNU C++ compiler uses an
   industry-standard C++ ABI starting with version 3. Details can be
-  found in the <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.codesourcery.com/public/cxx-abi/abi.html">ABI
+  found in the <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://mentorembedded.github.com/cxx-abi/abi.html">ABI
   specification</link>.
 </para>
 
@@ -717,7 +717,7 @@  class that would otherwise have implicit versions. This will change
 the way the compiler deals with this class in by-value return
 statements or parameters: instead of passing instances of this
 class in registers, the compiler will be forced to use memory. See the
-section on <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.codesourcery.com/public/cxx-abi/abi.html#calls">Function
+section on <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://mentorembedded.github.com/cxx-abi/abi.html#calls">Function
 Calling Conventions and APIs</link>
  of the C++ ABI documentation for further details.
 </para></listitem>
@@ -1075,7 +1075,7 @@  gcc test.c -g -O2 -L. -lone -ltwo /usr/lib/libstdc++.so.5 /usr/lib/libstdc++.so.
     <biblioentry xml:id="biblio.cxxabi">
       <title>
 	<link xmlns:xlink="http://www.w3.org/1999/xlink"
-	      xlink:href="http://www.codesourcery.com/public/cxx-abi">
+	      xlink:href="http://www.codesourcery.com/cxx-abi/">
 	  C++ ABI Summary
 	</link>
       </title>
diff --git a/libstdc++-v3/doc/xml/manual/bitmap_allocator.xml b/libstdc++-v3/doc/xml/manual/bitmap_allocator.xml
index 3bc489a..1450162 100644
--- a/libstdc++-v3/doc/xml/manual/bitmap_allocator.xml
+++ b/libstdc++-v3/doc/xml/manual/bitmap_allocator.xml
@@ -53,6 +53,7 @@ 
 </section>
 
 <section xml:id="allocator.bitmap.impl"><info><title>Implementation</title></info>
+<?dbhtml filename="bitmap_allocator_impl.html"?>
 
 
 <section xml:id="bitmap.impl.free_list_store" xreflabel="Free List Store"><info><title>Free List Store</title></info>
diff --git a/libstdc++-v3/doc/xml/manual/concurrency_extensions.xml b/libstdc++-v3/doc/xml/manual/concurrency_extensions.xml
index 0d0e1b9..aef588d 100644
--- a/libstdc++-v3/doc/xml/manual/concurrency_extensions.xml
+++ b/libstdc++-v3/doc/xml/manual/concurrency_extensions.xml
@@ -185,6 +185,7 @@  host hardware and operating system.
 
 
 <section xml:id="manual.ext.concurrency.impl" xreflabel="Implementation"><info><title>Implementation</title></info>
+  <?dbhtml filename="ext_concurrency_impl.html"?>
   
   <section xml:id="manual.ext.concurrency.impl.atomic_fallbacks" xreflabel="Atomic F"><info><title>Using Builtin Atomic Functions</title></info>
     
@@ -290,8 +291,8 @@  etc.
 </section>
 
 <section xml:id="manual.ext.concurrency.use" xreflabel="Use"><info><title>Use</title></info>
+<?dbhtml filename="ext_concurrency_use.html"?>
 
-  
 
 <para>Typical usage of the last two constructs is demonstrated as follows:
 </para>
diff --git a/libstdc++-v3/doc/xml/manual/debug_mode.xml b/libstdc++-v3/doc/xml/manual/debug_mode.xml
index 389f9bd..e7d309b 100644
--- a/libstdc++-v3/doc/xml/manual/debug_mode.xml
+++ b/libstdc++-v3/doc/xml/manual/debug_mode.xml
@@ -58,6 +58,7 @@ 
 </section>
 
 <section xml:id="manual.ext.debug_mode.semantics" xreflabel="Semantics"><info><title>Semantics</title></info>
+  <?dbhtml filename="debug_mode_semantics.html"?>
   
   <para>
   </para>
@@ -139,6 +140,7 @@  which always works correctly.
 </section>
 
 <section xml:id="manual.ext.debug_mode.using" xreflabel="Using"><info><title>Using</title></info>
+  <?dbhtml filename="debug_mode_using.html"?>
   
   <para>
   </para>
@@ -314,6 +316,7 @@  containers have additional debug capability.
 </section>
 
 <section xml:id="manual.ext.debug_mode.design" xreflabel="Design"><info><title>Design</title></info>
+  <?dbhtml filename="debug_mode_design.html"?>
   
   <para>
   </para>
diff --git a/libstdc++-v3/doc/xml/manual/diagnostics.xml b/libstdc++-v3/doc/xml/manual/diagnostics.xml
index 9b642b1..99206e9 100644
--- a/libstdc++-v3/doc/xml/manual/diagnostics.xml
+++ b/libstdc++-v3/doc/xml/manual/diagnostics.xml
@@ -72,6 +72,7 @@ 
 </section>
 
 <section xml:id="std.diagnostics.concept_checking" xreflabel="Concept Checking"><info><title>Concept Checking</title></info>
+  <?dbhtml filename="concept_checking.html"?>
   
   <para>
     In 1999, SGI added <quote>concept checkers</quote> to their
diff --git a/libstdc++-v3/doc/xml/manual/extensions.xml b/libstdc++-v3/doc/xml/manual/extensions.xml
index 522f562..1f3da2f 100644
--- a/libstdc++-v3/doc/xml/manual/extensions.xml
+++ b/libstdc++-v3/doc/xml/manual/extensions.xml
@@ -14,6 +14,7 @@ 
 
 
 <preface><info><title/></info>
+<?dbhtml filename="ext_preface.html"?>
 <para>
   Here we will make an attempt at describing the non-Standard
   extensions to the library.  Some of these are from older versions of
@@ -187,6 +188,7 @@  extensions, be aware of two things:
 
 
   <section xml:id="manual.ext.containers.deprecated_sgi" xreflabel="SGI ext dep"><info><title>Deprecated</title></info>
+    <?dbhtml filename="ext_sgi.html"?>
 
 
    <para>
diff --git a/libstdc++-v3/doc/xml/manual/mt_allocator.xml b/libstdc++-v3/doc/xml/manual/mt_allocator.xml
index 3e3a864..12fe2ee 100644
--- a/libstdc++-v3/doc/xml/manual/mt_allocator.xml
+++ b/libstdc++-v3/doc/xml/manual/mt_allocator.xml
@@ -41,6 +41,7 @@ 
 
 
 <section xml:id="allocator.mt.design_issues"><info><title>Design Issues</title></info>
+<?dbhtml filename="mt_allocator_design.html"?>
 
 
 <section xml:id="allocator.mt.overview"><info><title>Overview</title></info>
@@ -105,6 +106,7 @@  classes, namely member functions <code>allocate</code> and
 </section>
 
 <section xml:id="allocator.mt.impl"><info><title>Implementation</title></info>
+<?dbhtml filename="mt_allocator_impl.html"?>
 
 
 
@@ -314,6 +316,7 @@  pool that frees memory, see the following
 </section>
 
 <section xml:id="allocator.mt.example_single"><info><title>Single Thread Example</title></info>
+<?dbhtml filename="mt_allocator_ex_single.html"?>
 
 
 <para>
@@ -408,6 +411,7 @@  faster than maintaining a set of "last pointers" as well.
 </section>
 
 <section xml:id="allocator.mt.example_multi"><info><title>Multiple Thread Example</title></info>
+<?dbhtml filename="mt_allocator_ex_multi.html"?>
 
 
 <para>
diff --git a/libstdc++-v3/doc/xml/manual/parallel_mode.xml b/libstdc++-v3/doc/xml/manual/parallel_mode.xml
index 0ab59d5..6dc81c9 100644
--- a/libstdc++-v3/doc/xml/manual/parallel_mode.xml
+++ b/libstdc++-v3/doc/xml/manual/parallel_mode.xml
@@ -76,6 +76,7 @@  specific compiler flag.
 </section>
 
 <section xml:id="manual.ext.parallel_mode.semantics" xreflabel="Semantics"><info><title>Semantics</title></info>
+<?dbhtml filename="parallel_mode_semantics.html"?>
   
 
 <para> The parallel mode STL algorithms are currently not exception-safe,
@@ -93,6 +94,7 @@  It might work with other compilers, though.</para>
 </section>
 
 <section xml:id="manual.ext.parallel_mode.using" xreflabel="Using"><info><title>Using</title></info>
+<?dbhtml filename="parallel_mode_using.html"?>
   
 
 <section xml:id="parallel_mode.using.prereq_flags"><info><title>Prerequisite Compiler Flags</title></info>
@@ -457,6 +459,7 @@  flags for atomic operations.)
 </section>
 
 <section xml:id="manual.ext.parallel_mode.design" xreflabel="Design"><info><title>Design</title></info>
+<?dbhtml filename="parallel_mode_design.html"?>
   
   <para>
   </para>
@@ -783,6 +786,7 @@  the generated source documentation.
 </section>
 
 <section xml:id="manual.ext.parallel_mode.test" xreflabel="Testing"><info><title>Testing</title></info>
+<?dbhtml filename="parallel_mode_test.html"?>
   
 
   <para>
diff --git a/libstdc++-v3/doc/xml/manual/policy_data_structures.xml b/libstdc++-v3/doc/xml/manual/policy_data_structures.xml
index 9e6bb59..cf8af18 100644
--- a/libstdc++-v3/doc/xml/manual/policy_data_structures.xml
+++ b/libstdc++-v3/doc/xml/manual/policy_data_structures.xml
@@ -5053,6 +5053,7 @@ 
   <!-- S05: Reference/Acknowledgments -->
   <section xml:id="pbds.ack">
     <info><title>Acknowledgments</title></info>
+    <?dbhtml filename="policy_data_structures_ack.html"?>
 
     <para>
       Written by Ami Tavory and Vladimir Dreizin (IBM Haifa Research
diff --git a/libstdc++-v3/doc/xml/manual/policy_data_structures_biblio.xml b/libstdc++-v3/doc/xml/manual/policy_data_structures_biblio.xml
index ec8854a..11f798f 100644
--- a/libstdc++-v3/doc/xml/manual/policy_data_structures_biblio.xml
+++ b/libstdc++-v3/doc/xml/manual/policy_data_structures_biblio.xml
@@ -1,12 +1,8 @@ 
 
- <!-- Policy Based Data Structures: Biblio -->
- <bibliography xml:id="pbds.biblio">
-    <info>
-      <title>
-	Bibliography
-      </title>
-    </info>
-    <?dbhtml filename="policy_data_structures_biblio.html"?>
+<!-- Policy Based Data Structures: Biblio -->
+<bibliography xmlns="http://docbook.org/ns/docbook" version="5.0"
+	      xml:id="pbds.biblio" xreflabel="Bibliography">
+    <info><title>Bibliography</title></info>
 
     <!-- 01 -->
     <biblioentry xml:id="biblio.abrahams97exception">
diff --git a/libstdc++-v3/doc/xml/manual/profile_mode.xml b/libstdc++-v3/doc/xml/manual/profile_mode.xml
index adb3c87..59af2db 100644
--- a/libstdc++-v3/doc/xml/manual/profile_mode.xml
+++ b/libstdc++-v3/doc/xml/manual/profile_mode.xml
@@ -210,6 +210,7 @@  vector-size: improvement = 3: call stack = 0x804842c ...
 
 
 <section xml:id="manual.ext.profile_mode.design" xreflabel="Design"><info><title>Design</title></info>
+<?dbhtml filename="profile_mode_design.html"?>
   
 
 <para>
@@ -425,6 +426,7 @@  it helps the user focus on the key problems and ignore the uninteresting ones.
 </section>
 
 <section xml:id="manual.ext.profile_mode.api" xreflabel="API"><info><title>Extensions for Custom Containers</title></info>
+<?dbhtml filename="profile_mode_api.html"?>
 
 
   <para>
@@ -440,6 +442,7 @@  it helps the user focus on the key problems and ignore the uninteresting ones.
 
 
 <section xml:id="manual.ext.profile_mode.cost_model" xreflabel="Cost Model"><info><title>Empirical Cost Model</title></info>
+<?dbhtml filename="profile_mode_cost_model.html"?>
 
 
   <para>
@@ -465,6 +468,7 @@  it helps the user focus on the key problems and ignore the uninteresting ones.
 
 
 <section xml:id="manual.ext.profile_mode.implementation" xreflabel="Implementation"><info><title>Implementation Issues</title></info>
+<?dbhtml filename="profile_mode_impl.html"?>
 
 
 
@@ -557,6 +561,7 @@  it helps the user focus on the key problems and ignore the uninteresting ones.
 
 
 <section xml:id="manual.ext.profile_mode.developer" xreflabel="Developer Information"><info><title>Developer Information</title></info>
+<?dbhtml filename="profile_mode_devel.html"?>
 
 
 <section xml:id="manual.ext.profile_mode.developer.bigpic" xreflabel="Big Picture"><info><title>Big Picture</title></info>
@@ -660,6 +665,7 @@  it helps the user focus on the key problems and ignore the uninteresting ones.
 </section>
 
 <section xml:id="manual.ext.profile_mode.diagnostics"><info><title>Diagnostics</title></info>
+<?dbhtml filename="profile_mode_diagnostics.html"?>
 
 
   <para>
diff --git a/libstdc++-v3/doc/xml/manual/spine.xml b/libstdc++-v3/doc/xml/manual/spine.xml
index 806f4ec..614e886 100644
--- a/libstdc++-v3/doc/xml/manual/spine.xml
+++ b/libstdc++-v3/doc/xml/manual/spine.xml
@@ -19,6 +19,7 @@ 
     <year>2009</year>
     <year>2010</year>
     <year>2011</year>
+    <year>2012</year>
     <holder>
       <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.fsf.org">FSF</link>
     </holder>
@@ -158,6 +159,7 @@ 
     Standard Contents
   </title>
 </info>
+<?dbhtml filename="std_contents.html"?>
 
 
 <!-- Chapter 01 : Support -->
@@ -220,6 +222,7 @@ 
 <part xml:id="appendix" xreflabel="Appendices"><info><title>
   Appendices
 </title></info>
+<?dbhtml filename="appendix.html"?>
 
 
 <!-- Appendix A -->