[Boost-commit] svn:boost r86174 - trunk/libs/circular_buffer/doc

Subject: [Boost-commit] svn:boost r86174 - trunk/libs/circular_buffer/doc
From: dnljms_at_[hidden]
Date: 2013-10-06 04:03:35

Author: danieljames
Date: 2013-10-06 04:03:35 EDT (Sun, 06 Oct 2013)
New Revision: 86174
URL: http://svn.boost.org/trac/boost/changeset/86174

Log:
Try to fix some links in circular buffer.

Changes some links to use the location independent 'boost:' links.

Also changes the build settings so that 'boost:' is used as a prefix when
generating docbook. The reason is a bit obscure. When generating documentation
with an index, the docbook documentation has to first be generated separately,
so that the index doesn't get confused with other documents. But when this
happens the boost.root parameter from the circular buffer jamfile is used -
which was the wrong location. So I changed it to use the prefix 'boost:'
which will later get converted to the correct location when building the
combined documentation. Sorry if that doesn't make any sense, but hopefully it
should fix some broken links.

Text files modified: 
   trunk/libs/circular_buffer/doc/circular_buffer.qbk |    24 ++++++++++++------------                
   trunk/libs/circular_buffer/doc/jamfile.v2          |     3 ++-                                     
   2 files changed, 14 insertions(+), 13 deletions(-)

Modified: trunk/libs/circular_buffer/doc/circular_buffer.qbk
==============================================================================
--- trunk/libs/circular_buffer/doc/circular_buffer.qbk	Sun Oct  6 04:03:12 2013	(r86173)
+++ trunk/libs/circular_buffer/doc/circular_buffer.qbk	2013-10-06 04:03:35 EDT (Sun, 06 Oct 2013)	(r86174)
@@ -120,7 +120,7 @@
 
 [/circular_buffer_example_output - there is no output for this example]
 
-You can see the full example code at [@../../libs/circular_buffer/example/circular_buffer_example.cpp  circular_buffer_example.cpp].
+You can see the full example code at [@boost:libs/circular_buffer/example/circular_buffer_example.cpp  circular_buffer_example.cpp].
 
 The full annotated description is in the C++ Reference section.
 
@@ -150,7 +150,7 @@
 
 * Storage of the ['most recently received samples], overwriting the oldest as new samples arrive.
 * As an underlying container for a ['bounded buffer]
-(see the Bounded Buffer example, code at [@../../libs/circular_buffer/example/circular_buffer_bound_example.cpp  circular_buffer_bound_example.cpp]).
+(see the Bounded Buffer example, code at [@boost:libs/circular_buffer/example/circular_buffer_bound_example.cpp  circular_buffer_bound_example.cpp]).
 * A kind of ['cache] storing a specified number of last inserted elements.
 * Efficient fixed capacity ['FIFO (First In, First Out)],
 * Efficient fixed capacity ['LIFO (Last In, First Out)] queue which removes the oldest (inserted as first) elements when full.
@@ -174,7 +174,7 @@
 then the user is responsible for ensuring mutual exclusion between the threads during the container accesses.
 The mutual exclusion between the threads can be achieved by wrapping
 operations of the underlying __cb with a lock acquisition and release.
-(See the Bounded Buffer example code at [@../../libs/circular_buffer/example/circular_buffer_bound_example.cpp  circular_buffer_bound_example.cpp])
+(See the Bounded Buffer example code at [@boost:libs/circular_buffer/example/circular_buffer_bound_example.cpp  circular_buffer_bound_example.cpp])
 
 [h3 Overwrite Operation]
 
@@ -265,7 +265,7 @@
 This "soft" definition of iterator invalidation is supported by the __cb
 but should be considered as an implementation detail rather than a full-fledged feature.
 The rules when the iterator is still valid can be inferred from the code in
-[@../../libs/circular_buffer/test/soft_iterator_invalidation.cpp soft_iterator_invalidation.cpp].
+[@boost:libs/circular_buffer/test/soft_iterator_invalidation.cpp soft_iterator_invalidation.cpp].
 
 
 [h3 Move emulation and rvalues]
@@ -347,7 +347,7 @@
 
 Moreover, the uninitialized memory allocated by __cb is filled with the value `0xcc` in the debug mode.
 When debugging the code, this can help the programmer  to recognize the initialized memory from the uninitialized.
-For details refer the source code [@../../boost/circular_buffer/debug.hpp circular_buffer/debug.hpp].
+For details refer the source code [@boost:boost/circular_buffer/debug.hpp circular_buffer/debug.hpp].
 
 The debug support is enabled only in the debug mode (when the `NDEBUG` is not defined).
 It can also be explicitly disabled (only for __cb)
@@ -380,7 +380,7 @@
 The `std::accumulate` algorithm evaluates the sum of the stored elements.
 The semantics of the __cb can be inferred from the assertions.
 
-You can see the full example code at [@../../libs/circular_buffer/example/circular_buffer_sum_example.cpp  circular_buffer_sum_example.cpp].
+You can see the full example code at [@boost:libs/circular_buffer/example/circular_buffer_sum_example.cpp  circular_buffer_sum_example.cpp].
 
 [h3 Bounded Buffer Example]
 
@@ -436,7 +436,7 @@
 (removal) of an old item and a consequent inplace construction (insertion) of a new item.
 
 For comparison of bounded buffers based on different containers compile and
-run [@../../test/bounded_buffer_comparison.cpp bounded_buffer_comparison.cpp].
+run [@boost:libs/circular_buffer/test/bounded_buffer_comparison.cpp bounded_buffer_comparison.cpp].
 The test should reveal the bounded buffer based on the __cb is most effective
 closely followed by the `std::deque` based bounded buffer.
 (In reality, the result may differ sometimes because the test
@@ -444,23 +444,23 @@
 
 [import ../test/bounded_buffer_comparison.cpp]
 
-You can see the full test code at [@../../libs/circular_buffer/test/bounded_buffer_comparison.cpp bounded_buffer_comparison.cpp],
+You can see the full test code at [@boost:libs/circular_buffer/test/bounded_buffer_comparison.cpp bounded_buffer_comparison.cpp],
 and an example of output is [bounded_buffer_comparison_output].
 
 [endsect] [/section:examples More examples]
 
 [section:headers Header Files]
 
-The circular buffer library is defined in the file [@../../boost/circular_buffer.hpp circular_buffer.hpp].
+The circular buffer library is defined in the file [@boost:boost/circular_buffer.hpp circular_buffer.hpp].
 
   #include <boost/circular_buffer.hpp>
 
 (There is also a forward declaration for the __cb
-in the header file [@../../boost/circular_buffer_fwd.hpp circular_buffer_fwd.hpp]).
+in the header file [@boost:boost/circular_buffer_fwd.hpp circular_buffer_fwd.hpp]).
 
-The __cb is defined in the file [@../../boost/circular_buffer/base.hpp base.hpp].
+The __cb is defined in the file [@boost:boost/circular_buffer/base.hpp base.hpp].
 
-The __cbso is defined in the file [@../../boost/circular_buffer/space_optimized.hpp space_optimized.hpp].
+The __cbso is defined in the file [@boost:boost/circular_buffer/space_optimized.hpp space_optimized.hpp].
 
 [endsect] [/section:headers Header Files]
 

Modified: trunk/libs/circular_buffer/doc/jamfile.v2
==============================================================================
--- trunk/libs/circular_buffer/doc/jamfile.v2	Sun Oct  6 04:03:12 2013	(r86173)
+++ trunk/libs/circular_buffer/doc/jamfile.v2	2013-10-06 04:03:35 EDT (Sun, 06 Oct 2013)	(r86174)
@@ -106,7 +106,8 @@
    
    # General settings
    # =================
-   <xsl:param>boost.root=../../../..
+   <format>html:<xsl:param>boost.root=../../../..
+   <format>docbook:<xsl:param>boost.root=boost:
 
     # Options for html and pdf
     # ========================