Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r83132 - in branches/release: . doc doc/src libs libs/container libs/container/doc libs/interprocess libs/interprocess/doc libs/intrusive libs/intrusive/doc
From: dnljms_at_[hidden]
Date: 2013-02-24 09:46:28


Author: danieljames
Date: 2013-02-24 09:46:28 EST (Sun, 24 Feb 2013)
New Revision: 83132
URL: http://svn.boost.org/trac/boost/changeset/83132

Log:
Merge auto-index fixes. Fixes #7899.

Properties modified:
   branches/release/ (props changed)
   branches/release/doc/ (props changed)
   branches/release/libs/ (props changed)
   branches/release/libs/container/ (props changed)
   branches/release/libs/interprocess/ (props changed)
   branches/release/libs/intrusive/ (props changed)
Text files modified:
   branches/release/doc/Jamfile.v2 | 38 +++++++++++++++++++++++++++++---------
   branches/release/doc/src/boost.xml | 7 ++++---
   branches/release/libs/container/doc/Jamfile.v2 | 7 +++++--
   branches/release/libs/interprocess/doc/Jamfile.v2 | 9 ++++++---
   branches/release/libs/intrusive/doc/Jamfile.v2 | 7 +++++--
   5 files changed, 49 insertions(+), 19 deletions(-)

Modified: branches/release/doc/Jamfile.v2
==============================================================================
--- branches/release/doc/Jamfile.v2 (original)
+++ branches/release/doc/Jamfile.v2 2013-02-24 09:46:28 EST (Sun, 24 Feb 2013)
@@ -8,6 +8,28 @@
 
 alias asio : ../libs/asio/doc//asio/<xsl:param>boost.libraries=../../libs/libraries.htm ;
 
+#
+# Note that when refering to libraries that use auto-index we must process all the way to
+# docbook before including here. We must also ensure that auto-index uses it's own index
+# generation, otherwise we get one big index that's repeated in each library. Xslt's index
+# generation is also so slow that it's impractical for a build this large (takes ~ 9 hrs
+# to build with just 3 indexed libraries). Hence we refer to these libraries as for example:
+#
+# ../libs/interprocess/doc//standalone/<format>docbook
+#
+# Within each library that uses this, make sure that the boostbook target contains
+#
+# <format>docbook:<auto-index-internal>on
+#
+# And if boost.root is set, restrict it to local html builds using:
+#
+# <format>html:<xsl:param>boost.root=../../../..
+# <format>html:<xsl:param>boost.libraries=../../../../libs/libraries.htm
+#
+# Finally, in boost.xml we xi:include interproces.auto_index.docbook which is the final
+# post-index generation docbook, rather than interprocess.xml which is the pre-indexed boostbook.
+#
+
 boostbook doc
     :
     src/boost.xml
@@ -44,14 +66,11 @@
     <dependency>../libs/date_time/xmldoc//local_time_autodoc.xml
     <dependency>../tools/build/v2/doc//jam_docs
     <dependency>../tools/quickbook/doc//quickbook
- <dependency>../libs/interprocess/doc//autodoc.xml
- <dependency>../libs/interprocess/doc//interprocess
- <dependency>../libs/intrusive/doc//autodoc.xml
- <dependency>../libs/intrusive/doc//intrusive
+ <dependency>../libs/interprocess/doc//standalone/<format>docbook
+ <dependency>../libs/intrusive/doc//standalone/<format>docbook
     <dependency>../libs/move/doc//autodoc.xml
     <dependency>../libs/move/doc//move
- <dependency>../libs/container/doc//autodoc.xml
- <dependency>../libs/container/doc//container
+ <dependency>../libs/container/doc//standalone/<format>docbook
     <dependency>../libs/units/doc//units
     <dependency>../libs/unordered/doc//unordered
     <dependency>../libs/thread/doc//thread
@@ -82,9 +101,9 @@
     <implicit-dependency>../tools/build/v2/doc//jam_docs
     <implicit-dependency>../tools/quickbook/doc//quickbook
     <implicit-dependency>../libs/mpi/doc//mpi
- <implicit-dependency>../libs/container/doc//container
- <implicit-dependency>../libs/interprocess/doc//interprocess
- <implicit-dependency>../libs/intrusive/doc//intrusive
+ <implicit-dependency>../libs/container/doc//standalone/<format>docbook
+ <implicit-dependency>../libs/interprocess/doc//standalone/<format>docbook
+ <implicit-dependency>../libs/intrusive/doc//standalone/<format>docbook
     <implicit-dependency>../libs/move/doc//move
     <implicit-dependency>../libs/units/doc//units
     <implicit-dependency>../libs/unordered/doc//unordered
@@ -108,3 +127,4 @@
 explicit callouts ;
 
 
+

Modified: branches/release/doc/src/boost.xml
==============================================================================
--- branches/release/doc/src/boost.xml (original)
+++ branches/release/doc/src/boost.xml 2013-02-24 09:46:28 EST (Sun, 24 Feb 2013)
@@ -189,7 +189,7 @@
      </libraryinfo>
    </library>
 
- <xi:include href="container.xml"/>
+ <xi:include href="container.auto_index.docbook"/>
 
    <library name="Conversion" dirname="conversion" html-only="1"
             url="../../libs/conversion/index.html">
@@ -312,7 +312,7 @@
      </libraryinfo>
    </library>
 
- <xi:include href="interprocess.xml"/>
+ <xi:include href="interprocess.auto_index.docbook"/>
 
    <library name="Interval" dirname="numeric/interval" html-only="1"
             url="../../libs/numeric/interval/doc/index.html">
@@ -335,7 +335,7 @@
      </libraryinfo>
    </library>
 
- <xi:include href="intrusive.xml"/>
+ <xi:include href="intrusive.auto_index.docbook"/>
 
    <library name="I/O State Savers" dirname="io" html-only="1">
      <libraryinfo>
@@ -771,3 +771,4 @@
 </boostbook>
 
 
+

Modified: branches/release/libs/container/doc/Jamfile.v2
==============================================================================
--- branches/release/libs/container/doc/Jamfile.v2 (original)
+++ branches/release/libs/container/doc/Jamfile.v2 2013-02-24 09:46:28 EST (Sun, 24 Feb 2013)
@@ -48,8 +48,8 @@
    :
       container
    :
- <xsl:param>boost.root=../../../..
- <xsl:param>boost.libraries=../../../../libs/libraries.htm
+ <format>html:<xsl:param>boost.root=../../../..
+ <format>html:<xsl:param>boost.libraries=../../../../libs/libraries.htm
         <xsl:param>generate.section.toc.level=3
         <xsl:param>chunk.first.sections=1
         <format>pdf:<xsl:param>img.src.path=$(images_location)/
@@ -71,6 +71,7 @@
        
         # Choose indexing method for html:
         <format>html:<auto-index-internal>on
+ <format>docbook:<auto-index-internal>on
        
         # Set the name of the script file to use (index.idx is popular):
         <auto-index-script>$(here)/index.idx
@@ -89,3 +90,5 @@
 
 install pdfinstall : standalone/<format>pdf : <install-type>PDF <location>. <name>container.pdf ;
 explicit pdfinstall ;
+
+

Modified: branches/release/libs/interprocess/doc/Jamfile.v2
==============================================================================
--- branches/release/libs/interprocess/doc/Jamfile.v2 (original)
+++ branches/release/libs/interprocess/doc/Jamfile.v2 2013-02-24 09:46:28 EST (Sun, 24 Feb 2013)
@@ -52,8 +52,8 @@
    :
       interprocess
    :
- <xsl:param>boost.root=../../../..
- <xsl:param>boost.libraries=../../../../libs/libraries.htm
+ <format>html:<xsl:param>boost.root=../../../..
+ <format>html:<xsl:param>boost.libraries=../../../../libs/libraries.htm
         <xsl:param>toc.max.depth=1
         <xsl:param>toc.section.depth=2
         <xsl:param>chunk.first.sections=1
@@ -75,7 +75,8 @@
        
         # Choose indexing method for html:
         <format>html:<auto-index-internal>on
-
+ <format>docbook:<auto-index-internal>on
+
         # Set the name of the script file to use (index.idx is popular):
         <auto-index-script>$(here)/index.idx
         # Commands in the script file should all use RELATIVE PATHS
@@ -92,3 +93,5 @@
 
 install pdfinstall : standalone/<format>pdf : <location>. <name>interprocess.pdf <install-type>PDF <format>pdf ;
 explicit pdfinstall ;
+
+

Modified: branches/release/libs/intrusive/doc/Jamfile.v2
==============================================================================
--- branches/release/libs/intrusive/doc/Jamfile.v2 (original)
+++ branches/release/libs/intrusive/doc/Jamfile.v2 2013-02-24 09:46:28 EST (Sun, 24 Feb 2013)
@@ -55,8 +55,8 @@
    :
       intrusive
    :
- <xsl:param>boost.root=../../../..
- <xsl:param>boost.libraries=../../../../libs/libraries.htm
+ <format>html:<xsl:param>boost.root=../../../..
+ <format>html:<xsl:param>boost.libraries=../../../../libs/libraries.htm
         <xsl:param>generate.section.toc.level=3
         <xsl:param>chunk.first.sections=1
         <dependency>autodoc
@@ -76,6 +76,7 @@
 
         # Choose indexing method for html:
         <format>html:<auto-index-internal>on
+ <format>docbook:<auto-index-internal>on
 
         # Set the name of the script file to use (index.idx is popular):
         <auto-index-script>$(here)/index.idx
@@ -93,3 +94,5 @@
 
 install pdfinstall : standalone/<format>pdf : <name>intrusive.pdf <location>. <install-type>PDF <format>pdf ;
 explicit pdfinstall ;
+
+


Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk