Boost logo

Boost-Commit :

From: daniel_james_at_[hidden]
Date: 2008-04-27 03:39:51


Author: danieljames
Date: 2008-04-27 03:39:49 EDT (Sun, 27 Apr 2008)
New Revision: 44807
URL: http://svn.boost.org/trac/boost/changeset/44807

Log:
Merge in documentation fixes. Apart from the change to optional's documenation
Jamfile, which I included by mistake.

Fixes #1659, #1661, #1684, #1685, 1687, #1690, #1801

I wrote about this at:

http://lists.boost.org/Archives/boost/2008/04/136405.php

Merged revisions 44585-44806 via svnmerge from
https://svn.boost.org/svn/boost/branches/doc

........
  r44585 | danieljames | 2008-04-19 16:25:27 +0100 (Sat, 19 Apr 2008) | 2 lines
  
  Fix broken link to vacpp in bjam docs. Refs #1512
........
  r44586 | danieljames | 2008-04-19 16:27:36 +0100 (Sat, 19 Apr 2008) | 2 lines
  
  Fix broken link to bcpp in bjam docs. Refs #1513
........
  r44587 | danieljames | 2008-04-19 16:33:58 +0100 (Sat, 19 Apr 2008) | 2 lines
  
  DateTime documentation - Fix a link to the serialization library. Refs #1659
........
  r44588 | danieljames | 2008-04-19 16:35:36 +0100 (Sat, 19 Apr 2008) | 2 lines
  
  Fix some links in interprocess & intrusive. Refs #1661
........
  r44589 | danieljames | 2008-04-19 16:37:39 +0100 (Sat, 19 Apr 2008) | 2 lines
  
  Fix some links in the python docs. Refs #1684.
........
  r44590 | danieljames | 2008-04-19 16:38:29 +0100 (Sat, 19 Apr 2008) | 2 lines
  
  Work around a quickbook bug which is affecting the python docs. Refs #1684.
........
  r44591 | danieljames | 2008-04-19 16:39:34 +0100 (Sat, 19 Apr 2008) | 2 lines
  
  Fix a broken link in the numeric conversion docs. Refs #1685
........
  r44592 | danieljames | 2008-04-19 16:40:45 +0100 (Sat, 19 Apr 2008) | 2 lines
  
  Fix some links in the optional docs. Refs #1687
........
  r44593 | danieljames | 2008-04-19 16:42:09 +0100 (Sat, 19 Apr 2008) | 2 lines
  
  Fix link to the hash documentation from bimap. Refs #1690
........
  r44599 | danieljames | 2008-04-19 18:07:33 +0100 (Sat, 19 Apr 2008) | 2 lines
  
  Fix a typo in the format library. Refs #1801
........
  r44600 | danieljames | 2008-04-19 19:20:59 +0100 (Sat, 19 Apr 2008) | 1 line
  
  Initialise svnmerge.
........
  r44641 | danieljames | 2008-04-20 18:59:47 +0100 (Sun, 20 Apr 2008) | 2 lines
  
  Fix the lincense url in shared container iterator documentation.
........
  r44642 | danieljames | 2008-04-20 19:00:00 +0100 (Sun, 20 Apr 2008) | 2 lines
  
  Fix image link in the mpi documentation.
........
  r44643 | danieljames | 2008-04-20 19:00:11 +0100 (Sun, 20 Apr 2008) | 2 lines
  
  Fix a typo in the spirit docs.
........
  r44644 | danieljames | 2008-04-20 19:00:23 +0100 (Sun, 20 Apr 2008) | 2 lines
  
  Escape the slash so that quickbook doesn't think it the start of an italic section, and mess up the link. Refs #1844
........
  r44647 | danieljames | 2008-04-20 19:39:47 +0100 (Sun, 20 Apr 2008) | 2 lines
  
  Fix another typo in spirit docs.
........

Properties modified:
   trunk/ (props changed)
Text files modified:
   trunk/libs/bimap/doc/bimap_and_boost.qbk | 4 ++--
   trunk/libs/date_time/xmldoc/buildinfo.xml | 2 +-
   trunk/libs/format/doc/format.html | 2 +-
   trunk/libs/interprocess/doc/interprocess.qbk | 6 +++---
   trunk/libs/intrusive/doc/intrusive.qbk | 2 +-
   trunk/libs/mpi/doc/mpi.qbk | 2 +-
   trunk/libs/numeric/conversion/doc/conversion.qbk | 2 +-
   trunk/libs/optional/doc/optional.qbk | 2 +-
   trunk/libs/optional/index.html | 4 ++--
   trunk/libs/python/doc/building.rst | 2 +-
   trunk/libs/python/doc/tutorial/doc/tutorial.qbk | 4 ++--
   trunk/libs/python/doc/tutorial/index.html | 4 ++--
   trunk/libs/spirit/doc/notes/style_guide.qbk | 2 +-
   trunk/libs/spirit/doc/what_s_new.qbk | 2 +-
   trunk/libs/utility/shared_container_iterator.html | 2 +-
   trunk/tools/jam/doc/bjam.qbk | 8 ++++----
   16 files changed, 25 insertions(+), 25 deletions(-)

Modified: trunk/libs/bimap/doc/bimap_and_boost.qbk
==============================================================================
--- trunk/libs/bimap/doc/bimap_and_boost.qbk (original)
+++ trunk/libs/bimap/doc/bimap_and_boost.qbk 2008-04-27 03:39:49 EDT (Sun, 27 Apr 2008)
@@ -219,7 +219,7 @@
 This is a statistical property depending on the typical distribution of keys in a given application, so it is not feasible to have a general-purpose hash function with excellent results in every possible scenario; the default value for this parameter uses Boost.Hash, which often provides good enough results.
 
 Boost.Hash can be
-[@http://www.boost.org/regression-logs/cs-win32_metacomm/doc/html/hash/custom.html
+[@http://www.boost.org/doc/html/hash/custom.html
 extended for custom data types],
 enabling to use the default parameter of the unordered set types with any user types.
 
@@ -474,4 +474,4 @@
 
 [endsect]
 
-[endsect]
\ No newline at end of file
+[endsect]

Modified: trunk/libs/date_time/xmldoc/buildinfo.xml
==============================================================================
--- trunk/libs/date_time/xmldoc/buildinfo.xml (original)
+++ trunk/libs/date_time/xmldoc/buildinfo.xml 2008-04-27 03:39:49 EDT (Sun, 27 Apr 2008)
@@ -146,7 +146,7 @@
       <listitem><ulink url="../../libs/conversion/lexical_cast.htm">boost.lexical_cast </ulink> </listitem>
       <listitem><ulink url="../../libs/smart_ptr/smart_ptr.htm">boost.smart_ptr (local time only)</ulink> </listitem>
       <listitem><ulink url="../../libs/algorithm/string/">boost::string_algorithms </ulink> </listitem>
- <listitem><ulink url="../../libs/algorithm/serialize/">boost::serialize (serialization code only) </ulink> </listitem>
+ <listitem><ulink url="../../libs/serialization/index.html">boost::serialize (serialization code only) </ulink> </listitem>
     </itemizedlist>
     so these libraries need to be installed.
   </para>

Modified: trunk/libs/format/doc/format.html
==============================================================================
--- trunk/libs/format/doc/format.html (original)
+++ trunk/libs/format/doc/format.html 2008-04-27 03:39:49 EDT (Sun, 27 Apr 2008)
@@ -79,7 +79,7 @@
 
       <blockquote>
         <pre>
-cout &lt;&lt; format("%2% %1%") % 36 % 77 )
+cout &lt;&lt; format("%2% %1%") % 36 % 77;
 </pre>
       </blockquote>or later on, as in
 

Modified: trunk/libs/interprocess/doc/interprocess.qbk
==============================================================================
--- trunk/libs/interprocess/doc/interprocess.qbk (original)
+++ trunk/libs/interprocess/doc/interprocess.qbk 2008-04-27 03:39:49 EDT (Sun, 27 Apr 2008)
@@ -5704,7 +5704,7 @@
 to the segment manager. Because of this,
 in [*Boost.Interprocess] all managed memory segments derive from a common class that
 implements memory-independent (shared memory, memory mapped files) functions:
-[@../../../../boost/interprocess/detail/managed_memory_impl.hpp
+[@../../boost/interprocess/detail/managed_memory_impl.hpp
 boost::interprocess::detail::basic_managed_memory_impl]
 
 Deriving from this class, [*Boost.Interprocess] implements several managed memory
@@ -5766,7 +5766,7 @@
    to the segment manager.
 
 The pool is implemented by the
-[@../../../../boost/interprocess/allocators/detail/node_pool.hpp
+[@../../boost/interprocess/allocators/detail/node_pool.hpp
 private_node_pool and shared_node_pool] classes.
 
 [endsect]
@@ -5809,7 +5809,7 @@
    to the segment manager.
 
 The adaptive pool is implemented by the
-[@../../../../boost/interprocess/allocators/detail/adaptive_node_pool.hpp
+[@../../boost/interprocess/allocators/detail/adaptive_node_pool.hpp
 private_adaptive_node_pool and adaptive_node_pool] classes.
 
 [endsect]

Modified: trunk/libs/intrusive/doc/intrusive.qbk
==============================================================================
--- trunk/libs/intrusive/doc/intrusive.qbk (original)
+++ trunk/libs/intrusive/doc/intrusive.qbk 2008-04-27 03:39:49 EDT (Sun, 27 Apr 2008)
@@ -3011,7 +3011,7 @@
 `test_list` objects to funtion objects taking pointers to them.
 
 You can find the full test code code in the
-[@../../perf/perf_list.cpp perf_list.cpp] source file.
+[@../../libs/intrusive/perf/perf_list.cpp perf_list.cpp] source file.
 
 [section:performance_results_push_back Back insertion and destruction]
 

Modified: trunk/libs/mpi/doc/mpi.qbk
==============================================================================
--- trunk/libs/mpi/doc/mpi.qbk (original)
+++ trunk/libs/mpi/doc/mpi.qbk 2008-04-27 03:39:49 EDT (Sun, 27 Apr 2008)
@@ -2004,7 +2004,7 @@
 [@http://www.open-mpi.org/ Open MPI] version 1.1. The NetPIPE results
 follow:
 
-[$../../../libs/mpi/doc/netpipe.png]
+[$../../libs/mpi/doc/netpipe.png]
 
 There are a some observations we can make about these NetPIPE
 results. First of all, the top two plots show that Boost.MPI performs

Modified: trunk/libs/numeric/conversion/doc/conversion.qbk
==============================================================================
--- trunk/libs/numeric/conversion/doc/conversion.qbk (original)
+++ trunk/libs/numeric/conversion/doc/conversion.qbk 2008-04-27 03:39:49 EDT (Sun, 27 Apr 2008)
@@ -21,7 +21,7 @@
 
 [/ Cited Boost resources ]
 
-[def __MPL_INTEGRAL_CONSTANT__ [@../../../../mpl/refmanual/integral-constant.html MPL's Integral Constant] ]
+[def __MPL_INTEGRAL_CONSTANT__ [@../../../../mpl/doc/refmanual/integral-constant.html MPL's Integral Constant] ]
 
 
 

Modified: trunk/libs/optional/doc/optional.qbk
==============================================================================
--- trunk/libs/optional/doc/optional.qbk (original)
+++ trunk/libs/optional/doc/optional.qbk 2008-04-27 03:39:49 EDT (Sun, 27 Apr 2008)
@@ -22,7 +22,7 @@
 [/ Cited Boost resources ]
 
 [def __BOOST_VARIANT__ [@../../../variant/index.html Boost.Variant]]
-[def __BOOST_TRIBOOL__ [@../../../tribool/index.html boost::tribool]]
+[def __BOOST_TRIBOOL__ [@../../../../doc/html/tribool.html boost::tribool]]
 
 [def __OPTIONAL_POINTEE__ [@../../../utility/OptionalPointee.html OptionalPointee]]
 [def __COPY_CONSTRUCTIBLE__ [@../../../utility/CopyConstructible.html Copy Constructible]]

Modified: trunk/libs/optional/index.html
==============================================================================
--- trunk/libs/optional/index.html (original)
+++ trunk/libs/optional/index.html 2008-04-27 03:39:49 EDT (Sun, 27 Apr 2008)
@@ -4,10 +4,10 @@
 </head>
 <body>
 Automatic redirection failed, please go to
-doc/html/index.html.&nbsp;<hr>
+doc/html/index.html.&nbsp;<hr>
 <p>� Copyright Beman Dawes, 2001</p>
 <p>Distributed under the Boost Software License, Version 1.0. (See accompanying
 file LICENSE_1_0.txt or copy
 at www.boost.org/LICENSE_1_0.txt)</p>
 </body>
-</html>
\ No newline at end of file
+</html>

Modified: trunk/libs/python/doc/building.rst
==============================================================================
--- trunk/libs/python/doc/building.rst (original)
+++ trunk/libs/python/doc/building.rst 2008-04-27 03:39:49 EDT (Sun, 27 Apr 2008)
@@ -11,7 +11,7 @@
    :alt: Boost C++ Libraries:
    :class: boost-logo
 
-__ ../index.htm
+__ ../index.html
 
 
 .. section-numbering::

Modified: trunk/libs/python/doc/tutorial/doc/tutorial.qbk
==============================================================================
--- trunk/libs/python/doc/tutorial/doc/tutorial.qbk (original)
+++ trunk/libs/python/doc/tutorial/doc/tutorial.qbk 2008-04-27 03:39:49 EDT (Sun, 27 Apr 2008)
@@ -1381,9 +1381,9 @@
 [section Using the interpreter]
 
 As you probably already know, objects in Python are reference-counted.
-Naturally, the [^PyObject]s of the Python/C API are also reference-counted.
+Naturally, the [^PyObject]s of the Python\/C API are also reference-counted.
 There is a difference however. While the reference-counting is fully
-automatic in Python, the Python/C API requires you to do it
+automatic in Python, the Python\/C API requires you to do it
 [@http://www.python.org/doc/current/api/refcounts.html by hand]. This is
 messy and especially hard to get right in the presence of C++ exceptions.
 Fortunately Boost.Python provides the [@../../../v2/handle.html handle] and

Modified: trunk/libs/python/doc/tutorial/index.html
==============================================================================
--- trunk/libs/python/doc/tutorial/index.html (original)
+++ trunk/libs/python/doc/tutorial/index.html 2008-04-27 03:39:49 EDT (Sun, 27 Apr 2008)
@@ -11,8 +11,8 @@
     <a href="doc/html/index.html">link</a> &nbsp;<hr>
     <p>© Copyright Beman Dawes, 2001</p>
     <p>Distributed under the Boost Software License, Version 1.0. (See
- accompanying file <a href="../../../LICENSE_1_0.txt">
+ accompanying file <a href="../../../../LICENSE_1_0.txt">
     LICENSE_1_0.txt</a> or copy at
     <a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</p>
   </body>
-</html>
\ No newline at end of file
+</html>

Modified: trunk/libs/spirit/doc/notes/style_guide.qbk
==============================================================================
--- trunk/libs/spirit/doc/notes/style_guide.qbk (original)
+++ trunk/libs/spirit/doc/notes/style_guide.qbk 2008-04-27 03:39:49 EDT (Sun, 27 Apr 2008)
@@ -11,7 +11,7 @@
 keep an easy-to-read, consistent en aesthetically pleasing look to the Spirit
 code, the following coding styleguide is advised.
 
-This coding style is adapted and extended from the ANTLR/PCCTS style (Terrence
+This coding style is adapted and extended from the ANTLR\/PCCTS style (Terrence
 Parr) and [@http://groups.yahoo.com/group/boost/files/coding_guidelines.html
 Boost coding guidelines] (David Abrahams and Nathan Myers) and is the
 combined work of Joel de Guzman, Chris Uzdavinis and Hartmut Kaiser.

Modified: trunk/libs/spirit/doc/what_s_new.qbk
==============================================================================
--- trunk/libs/spirit/doc/what_s_new.qbk (original)
+++ trunk/libs/spirit/doc/what_s_new.qbk 2008-04-27 03:39:49 EDT (Sun, 27 Apr 2008)
@@ -35,7 +35,7 @@
 corrected as described above. As an alternative you can define the preprocessor
 constant `BOOST_SPIRIT_USE_OLD_NAMESPACE`, which will force the Spirit Classic
 code to be in the namespace `boost::spirit` as before. This is not recommended,
-though, as it maz result in naming clashs
+though, as it may result in naming clashes.
 
 The change of the namespace will be automatically deactivated whenever the
 deprecated include files are being used. This ensures full backwards

Modified: trunk/libs/utility/shared_container_iterator.html
==============================================================================
--- trunk/libs/utility/shared_container_iterator.html (original)
+++ trunk/libs/utility/shared_container_iterator.html 2008-04-27 03:39:49 EDT (Sun, 27 Apr 2008)
@@ -315,7 +315,7 @@
 <p>© Copyright 2003 The Trustees of Indiana University.
  Use, modification and distribution is subject to the Boost Software
  License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
- http:www.boost.org/LICENSE_1_0.txt)</p>
+ http://www.boost.org/LICENSE_1_0.txt)</p>
 
 </body>
 

Modified: trunk/tools/jam/doc/bjam.qbk
==============================================================================
--- trunk/tools/jam/doc/bjam.qbk (original)
+++ trunk/tools/jam/doc/bjam.qbk 2008-04-27 03:39:49 EDT (Sun, 27 Apr 2008)
@@ -124,7 +124,7 @@
 
 [ [=build.bat=] [Windows NT, 2000, and XP]
     [[lines
- [line [@http://www.borland.com/bcppbuilder/freecompiler =borland=]]
+ [line [@http://www.codegear.com/downloads/free/cppbuilder =borland=]]
         [line [@http://www.borland.com/ Borland] C++Builder (BCC 5.5)]
         ]]
     [[list
@@ -291,7 +291,7 @@
 
 [ [] []
     [[lines
- [line [@http://www.borland.com/bcppbuilder/freecompiler =kylix=]]
+ [line [@http://www.codegear.com/downloads/free/cppbuilder =kylix=]]
         [line [@http://www.borland.com/ Borland] C++Builder]
         ]]
     [[list
@@ -341,7 +341,7 @@
 
 [ [] []
     [[lines
- [line [@http://www-3.ibm.com/software/ad/vacpp/ =vacpp=]]
+ [line [@http://www-306.ibm.com/software/awdtools/vacpp/ =vacpp=]]
         [line IBM VisualAge C++]
         ]]
     [[list
@@ -1801,4 +1801,4 @@
 
 [section History]
 [include history.qbk]
-[endsect]
\ No newline at end of file
+[endsect]


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