Fixed bad formatting in FAQ.

BoostGSoC13 · Oct 1, 2013 · 6b37f8c · 6b37f8c
1 parent a47e534
commit 6b37f8c
Show file tree

Hide file tree

Showing 72 changed files with 135 additions and 186 deletions.
diff --git a/libs/afio/doc/generated/class_async_file_io_dispatcher_base.qbk b/libs/afio/doc/generated/class_async_file_io_dispatcher_base.qbk
@@ -75,26 +75,6 @@ This is a reference counted instance with platform-specific implementation optio
 An async_io_op with the same shared future as all op refs with this id. 
 
 
-]]
-[[``std::vector< async_io_op > completion(const std::vector< async_io_op > & ops, const std::vector< std::pair< async_op_flags, async_file_io_dispatcher_base::completion_t * >> & callbacks)``
-
-] [] [[* const std::vector< async_io_op > &]: ['ops]:  
-
-[* const std::vector< std::pair< async_op_flags, async_file_io_dispatcher_base::completion_t * >> &]: ['callbacks]:  
-
-
-
-
-]]
-[[``async_io_op completion(const async_io_op & req, const std::pair< async_op_flags, async_file_io_dispatcher_base::completion_t * > & callback)``
-
-] [] [[* const async_io_op &]: ['req]:  
-
-[* const std::pair< async_op_flags, async_file_io_dispatcher_base::completion_t * > &]: ['callback]:  
-
-
-
-
 ]]
 [[``std::vector< async_io_op > completion(const std::vector< async_io_op > & ops, const std::vector< std::pair< async_op_flags, std::function< async_file_io_dispatcher_base::completion_t >>> & callbacks)``
 

diff --git a/libs/afio/doc/html/afio/FAQ/closure_performance.html b/libs/afio/doc/html/afio/FAQ/closure_performance.html
@@ -122,27 +122,27 @@
               </td>
 <td>
                 <p>
-                  32%
+                  <span class="alignright">32%</span>
                 </p>
               </td>
 <td>
                 <p>
-                  21%
+                  <span class="alignright">21%</span>
                 </p>
               </td>
 <td>
                 <p>
-                  55%
+                  <span class="alignright">55%</span>
                 </p>
               </td>
 <td>
                 <p>
-                  26%
+                  <span class="alignright">26%</span>
                 </p>
               </td>
 <td>
                 <p>
-                  100%
+                  <span class="alignright">100%</span>
                 </p>
               </td>
 </tr>
@@ -186,27 +186,27 @@
               </td>
 <td>
                 <p>
-                  68%
+                  <span class="alignright">68%</span>
                 </p>
               </td>
 <td>
                 <p>
-                  49%
+                  <span class="alignright">49%</span>
                 </p>
               </td>
 <td>
                 <p>
-                  89%
+                  <span class="alignright">89%</span>
                 </p>
               </td>
 <td>
                 <p>
-                  60%
+                  <span class="alignright">60%</span>
                 </p>
               </td>
 <td>
                 <p>
-                  100%
+                  <span class="alignright">100%</span>
                 </p>
               </td>
 </tr>
@@ -250,27 +250,27 @@
               </td>
 <td>
                 <p>
-                  24%
+                  <span class="alignright">24%</span>
                 </p>
               </td>
 <td>
                 <p>
-                  17%
+                  <span class="alignright">17%</span>
                 </p>
               </td>
 <td>
                 <p>
-                  37%
+                  <span class="alignright">37%</span>
                 </p>
               </td>
 <td>
                 <p>
-                  23%
+                  <span class="alignright">23%</span>
                 </p>
               </td>
 <td>
                 <p>
-                  100%
+                  <span class="alignright">100%</span>
                 </p>
               </td>
 </tr>
@@ -289,8 +289,10 @@
         paired with a CPU with more cores, AFIO's almost wait free design ought to
         scale out fairly well too such that it may be able to max out even top end
         PCIe SSDs, some of which can push 10m IOPS now. If that isn't fast enough
-        for you, you can try AFIO's experimental transactional memory support with
-        a suitable compiler too.
+        for you, try AFIO on an Intel CPU with memory transaction support (on Windows
+        a runtime check will automatically replace locks with memory transactions,
+        for POSIX you need to recompile with the <code class="computeroutput"><span class="special">-</span><span class="identifier">mrtm</span></code> flag), or try support for <code class="computeroutput"><span class="identifier">__transaction_relaxed</span></code> compilers if <code class="computeroutput"><span class="identifier">BOOST_HAVE_TRANSACTIONAL_MEMORY_COMPILER</span></code>
+        is defined.
       </p>
 <p>
         Nevertheless, AFIO will almost certainly be still criticised for poor performance

diff --git a/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base.html b/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base.html
@@ -94,7 +94,7 @@
 <dt><span class="section"><a href="async_file_io_dispatcher_base/page_size.html">page_size</a></span></dt>
 </dl></div>
 <p>
-          <a class="indexterm" name="id903430"></a>
+          <a class="indexterm" name="id889747"></a>
 Abstract base class for dispatching file i/o asynchronously.
         </p>
 <h6>
@@ -269,40 +269,6 @@ <h6>
 </tr>
 <tr>
 <td>
-<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">async_io_op</span> <span class="special">&gt;</span> <span class="identifier">completion</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">async_io_op</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">ops</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span> <span class="identifier">async_op_flags</span><span class="special">,</span> <span class="identifier">async_file_io_dispatcher_base</span><span class="special">::</span><span class="identifier">completion_t</span> <span class="special">*</span> <span class="special">&gt;&gt;</span> <span class="special">&amp;</span> <span class="identifier">callbacks</span><span class="special">)</span></pre>
-                </td>
-<td>
-                </td>
-<td>
-                  <p>
-                    <span class="bold"><strong>const std::vector&lt; async_io_op &gt;
-                    &amp;</strong></span>: <span class="emphasis"><em>ops</em></span>:
-                  </p>
-                  <p>
-                    <span class="bold"><strong>const std::vector&lt; std::pair&lt; async_op_flags,
-                    async_file_io_dispatcher_base::completion_t * &gt;&gt; &amp;</strong></span>:
-                    <span class="emphasis"><em>callbacks</em></span>:
-                  </p>
-                </td>
-</tr>
-<tr>
-<td>
-<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">async_io_op</span> <span class="identifier">completion</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">async_io_op</span> <span class="special">&amp;</span> <span class="identifier">req</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span> <span class="identifier">async_op_flags</span><span class="special">,</span> <span class="identifier">async_file_io_dispatcher_base</span><span class="special">::</span><span class="identifier">completion_t</span> <span class="special">*</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">callback</span><span class="special">)</span></pre>
-                </td>
-<td>
-                </td>
-<td>
-                  <p>
-                    <span class="bold"><strong>const async_io_op &amp;</strong></span>: <span class="emphasis"><em>req</em></span>:
-                  </p>
-                  <p>
-                    <span class="bold"><strong>const std::pair&lt; async_op_flags, async_file_io_dispatcher_base::completion_t
-                    * &gt; &amp;</strong></span>: <span class="emphasis"><em>callback</em></span>:
-                  </p>
-                </td>
-</tr>
-<tr>
-<td>
 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">async_io_op</span> <span class="special">&gt;</span> <span class="identifier">completion</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">async_io_op</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span class="identifier">ops</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span> <span class="identifier">async_op_flags</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">function</span><span class="special">&lt;</span> <span class="identifier">async_file_io_dispatcher_base</span><span class="special">::</span><span class="identifier">completion_t</span> <span class="special">&gt;&gt;&gt;</span> <span class="special">&amp;</span> <span class="identifier">callbacks</span><span class="special">)</span></pre>
                 </td>
 <td>

diff --git a/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/adopt_1_batch.html b/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/adopt_1_batch.html
@@ -28,7 +28,7 @@
           (batch)</a>
 </h5></div></div></div>
 <p>
-            <a class="indexterm" name="id919735"></a>
+            <a class="indexterm" name="id905703"></a>
 Schedule a batch of third party handle adoptions.
           </p>
 <h6>

diff --git a/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/adopt_1_single.html b/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/adopt_1_single.html
@@ -28,7 +28,7 @@
           (single)</a>
 </h5></div></div></div>
 <p>
-            <a class="indexterm" name="id923321"></a>
+            <a class="indexterm" name="id908476"></a>
 Schedule an adoption of a third party handle.
           </p>
 <h6>

diff --git a/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/barrier.html b/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/barrier.html
@@ -28,7 +28,7 @@
           (batch)</a>
 </h5></div></div></div>
 <p>
-            <a class="indexterm" name="id975959"></a>
+            <a class="indexterm" name="id965878"></a>
 Schedule an asynchronous synchronisation of preceding operations.
           </p>
 <h6>

diff --git a/...ses/async_file_io_dispatcher_base/call_1_batch_bound_functions_without_preconditions.html b/...ses/async_file_io_dispatcher_base/call_1_batch_bound_functions_without_preconditions.html
@@ -28,7 +28,7 @@
           (batch bound functions without preconditions)</a>
 </h5></div></div></div>
 <p>
-            <a class="indexterm" name="id915634"></a>
+            <a class="indexterm" name="id901107"></a>
 Schedule a batch of asynchronous invocations of the specified bound functions
             when their supplied preconditions complete.
           </p>

diff --git a/...ml/afio/reference/classes/async_file_io_dispatcher_base/call_2_batch_bound_functions.html b/...ml/afio/reference/classes/async_file_io_dispatcher_base/call_2_batch_bound_functions.html
@@ -28,7 +28,7 @@
           (batch bound functions)</a>
 </h5></div></div></div>
 <p>
-            <a class="indexterm" name="id912113"></a>
+            <a class="indexterm" name="id902153"></a>
 Schedule a batch of asynchronous invocations of the specified bound functions
             when their supplied preconditions complete.
           </p>

diff --git a/.../afio/reference/classes/async_file_io_dispatcher_base/call_3_single_unbound_callable.html b/.../afio/reference/classes/async_file_io_dispatcher_base/call_3_single_unbound_callable.html
@@ -28,7 +28,7 @@
           (single unbound callable)</a>
 </h5></div></div></div>
 <p>
-            <a class="indexterm" name="id914515"></a>
+            <a class="indexterm" name="id906707"></a>
 Schedule an asynchronous invocation of the specified unbound callable
             when its supplied precondition completes. Note that this function essentially
             calls <code class="literal"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">bind</span><span class="special">()</span></code></code>

diff --git a/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/close_1_batch.html b/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/close_1_batch.html
@@ -28,7 +28,7 @@
           (batch)</a>
 </h5></div></div></div>
 <p>
-            <a class="indexterm" name="id922249"></a>
+            <a class="indexterm" name="id909638"></a>
 Schedule a batch of asynchronous file or directory handle closes after
             preceding operations.
           </p>

diff --git a/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/close_1_single.html b/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/close_1_single.html
@@ -28,7 +28,7 @@
           (single)</a>
 </h5></div></div></div>
 <p>
-            <a class="indexterm" name="id929317"></a>
+            <a class="indexterm" name="id917386"></a>
 Schedule an asynchronous file or directory handle close after a preceding
             operation.
           </p>

diff --git a/...o/reference/classes/async_file_io_dispatcher_base/completion_2_batch_bound_functions.html b/...o/reference/classes/async_file_io_dispatcher_base/completion_2_batch_bound_functions.html
@@ -28,7 +28,7 @@
           (batch bound functions)</a>
 </h5></div></div></div>
 <p>
-            <a class="indexterm" name="id907962"></a>
+            <a class="indexterm" name="id895299"></a>
 Schedule a batch of asynchronous invocations of the specified functions
             when their supplied operations complete.
           </p>

diff --git a/...o/reference/classes/async_file_io_dispatcher_base/completion_2_single_bound_function.html b/...o/reference/classes/async_file_io_dispatcher_base/completion_2_single_bound_function.html
@@ -28,7 +28,7 @@
           (single bound function)</a>
 </h5></div></div></div>
 <p>
-            <a class="indexterm" name="id913067"></a>
+            <a class="indexterm" name="id898753"></a>
 Schedule the asynchronous invocation of the specified single function
             when the supplied single operation completes.
           </p>

diff --git a/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/dir_1_batch.html b/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/dir_1_batch.html
@@ -28,7 +28,7 @@
           (batch)</a>
 </h5></div></div></div>
 <p>
-            <a class="indexterm" name="id928235"></a>
+            <a class="indexterm" name="id916306"></a>
 Schedule a batch of asynchronous directory creations and opens after
             optional preconditions.
           </p>

diff --git a/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/dir_1_single.html b/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/dir_1_single.html
@@ -28,7 +28,7 @@
           (single)</a>
 </h5></div></div></div>
 <p>
-            <a class="indexterm" name="id933364"></a>
+            <a class="indexterm" name="id918272"></a>
 Schedule an asynchronous directory creation and open after an optional
             precondition.
           </p>

diff --git a/...afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/enumerate_1_batch.html b/...afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/enumerate_1_batch.html
@@ -28,7 +28,7 @@
           (batch)</a>
 </h5></div></div></div>
 <p>
-            <a class="indexterm" name="id979705"></a>
+            <a class="indexterm" name="id965287"></a>
 Schedule a batch of asynchronous directory enumerations after a preceding
             operations.
           </p>

diff --git a/...fio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/enumerate_1_single.html b/...fio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/enumerate_1_single.html
@@ -28,7 +28,7 @@
           (single)</a>
 </h5></div></div></div>
 <p>
-            <a class="indexterm" name="id982502"></a>
+            <a class="indexterm" name="id969299"></a>
 Schedule an asynchronous directory enumeration after a preceding operation.
           </p>
 <h6>

diff --git a/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/file_1_batch.html b/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/file_1_batch.html
@@ -28,7 +28,7 @@
           (batch)</a>
 </h5></div></div></div>
 <p>
-            <a class="indexterm" name="id932429"></a>
+            <a class="indexterm" name="id919587"></a>
 Schedule a batch of asynchronous file creations and opens after optional
             preconditions.
           </p>

diff --git a/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/file_1_single.html b/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/file_1_single.html
@@ -28,7 +28,7 @@
           (single)</a>
 </h5></div></div></div>
 <p>
-            <a class="indexterm" name="id936098"></a>
+            <a class="indexterm" name="id922490"></a>
 Schedule an asynchronous file creation and open after an optional precondition.
           </p>
 <h6>

diff --git a/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/page_size.html b/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/page_size.html
@@ -27,7 +27,7 @@
 <a name="afio.reference.classes.async_file_io_dispatcher_base.page_size"></a><a class="link" href="page_size.html" title="page_size">page_size</a>
 </h5></div></div></div>
 <p>
-            <a class="indexterm" name="id985319"></a>
+            <a class="indexterm" name="id972657"></a>
 Returns the page size of this architecture which is useful for calculating
             direct i/o multiples.
           </p>

diff --git a/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/read_1_batch.html b/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/read_1_batch.html
@@ -28,7 +28,7 @@
           (batch)</a>
 </h5></div></div></div>
 <p>
-            <a class="indexterm" name="id935020"></a>
+            <a class="indexterm" name="id925646"></a>
 Schedule a batch of asynchronous data reads after preceding operations.
           </p>
 <h6>

diff --git a/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/read_1_single.html b/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/read_1_single.html
@@ -28,7 +28,7 @@
           (single)</a>
 </h5></div></div></div>
 <p>
-            <a class="indexterm" name="id939250"></a>
+            <a class="indexterm" name="id929436"></a>
 Schedule an asynchronous data read after a preceding operation.
           </p>
 <h6>

diff --git a/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/rmdir_1_batch.html b/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/rmdir_1_batch.html
@@ -28,7 +28,7 @@
           (batch)</a>
 </h5></div></div></div>
 <p>
-            <a class="indexterm" name="id942661"></a>
+            <a class="indexterm" name="id932813"></a>
 Schedule a batch of asynchronous directory deletions after optional preconditions.
           </p>
 <h6>

diff --git a/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/rmdir_1_single.html b/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/rmdir_1_single.html
@@ -28,7 +28,7 @@
           (single)</a>
 </h5></div></div></div>
 <p>
-            <a class="indexterm" name="id947195"></a>
+            <a class="indexterm" name="id931802"></a>
 Schedule an asynchronous directory deletion after an optional precondition.
           </p>
 <h6>

diff --git a/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/rmfile_1_batch.html b/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/rmfile_1_batch.html
@@ -28,7 +28,7 @@
           (batch)</a>
 </h5></div></div></div>
 <p>
-            <a class="indexterm" name="id946076"></a>
+            <a class="indexterm" name="id934147"></a>
 Schedule a batch of asynchronous file deletions after optional preconditions.
           </p>
 <h6>

diff --git a/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/rmfile_1_single.html b/libs/afio/doc/html/afio/reference/classes/async_file_io_dispatcher_base/rmfile_1_single.html
@@ -28,7 +28,7 @@
           (single)</a>
 </h5></div></div></div>
 <p>
-            <a class="indexterm" name="id950276"></a>
+            <a class="indexterm" name="id935336"></a>
 Schedule an asynchronous file deletion after an optional precondition.
           </p>
 <h6>