Skip to content

Commit

Permalink
Refined documents.
Browse files Browse the repository at this point in the history 
Added comparison environment information.
Added a link to separate compilation on config.
  • Loading branch information
@redboltz
redboltz committed Jun 19, 2024
1 parent 544a033 commit 6bf6c1a
Show file tree
Hide file tree
Showing 4 changed files with 77 additions and 35 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
* Added bind_cancellation_slot test #268
* Supported PINGREQ overriding by ServerKeepAlive. #271
* Refined tests. #269, #274, #275, #287, #288, #289, #290, #296, #297
* Refined documents. #276, #292, #305, #306
* Refined documents. #276, #292, #305, #306, #307
* Refined tools (bench) #278
* Added endpoint getter to client. #279

Expand Down
2 changes: 1 addition & 1 deletion doc/CHANGELOG.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ <h1>History</h1>
<p>Refined tests. #269, #274, #275, #287, #288, #289, #290, #296, #297</p>
</li>
<li>
<p>Refined documents. #276, #292, #305, #306</p>
<p>Refined documents. #276, #292, #305, #306, #307</p>
</li>
<li>
<p>Refined tools (bench) #278</p>
Expand Down
92 changes: 61 additions & 31 deletions doc/comparison.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -356,13 +356,12 @@ <h2 id="_misc">Misc</h2>
</tr>
</tbody>
</table>
<div class="paragraph">
<p>Detail information of Compilation Time and Footprint size:</p>
</div>
<div class="sect2">
<h3 id="_detail_information_of_compilation_time_and_footprint_size">Detail information of Compilation Time and Footprint size</h3>
<div class="ulist">
<ul>
<li>
<p>Repository:</p>
<p>Repository for measuring:</p>
<div class="ulist">
<ul>
<li>
Expand All @@ -372,7 +371,7 @@ <h2 id="_misc">Misc</h2>
</div>
</li>
<li>
<p>Commit:</p>
<p>Commit hash:</p>
<div class="ulist">
<ul>
<li>
Expand All @@ -381,6 +380,36 @@ <h2 id="_misc">Misc</h2>
</ul>
</div>
</li>
<li>
<p>Operating system</p>
<div class="ulist">
<ul>
<li>
<p>Linux 6.8.7-arch1-2 #1 SMP PREEMPT_DYNAMIC Fri, 19 Apr 2024 09:51:31 +0000 x86_64 GNU/Linux</p>
</li>
</ul>
</div>
</li>
<li>
<p>CPU</p>
<div class="ulist">
<ul>
<li>
<p>Intel&#174; Core&#8482; i7-6700 CPU @ 3.40GHz, 8 cores</p>
</li>
</ul>
</div>
</li>
<li>
<p>RAM</p>
<div class="ulist">
<ul>
<li>
<p>64GB</p>
</li>
</ul>
</div>
</li>
</ul>
</div>
<div class="listingblock">
Expand All @@ -392,10 +421,10 @@ <h2 id="_misc">Misc</h2>
cmake -DCMAKE_CXX_FLAGS="-std=c++20" ..</code></pre>
</div>
</div>
<div class="sect2">
<h3 id="_compilation_time_no_optimization">Compilation time (no optimization)</h3>
<div class="sect3">
<h4 id="_async_mqtt5_header_only">async-mqtt5 (header-only)</h4>
<h4 id="_compilation_time_no_optimization">Compilation time (no optimization)</h4>
<div class="sect4">
<h5 id="_async_mqtt5_header_only">async-mqtt5 (header-only)</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>time make check_async-mqtt5
Expand All @@ -406,8 +435,8 @@ <h4 id="_async_mqtt5_header_only">async-mqtt5 (header-only)</h4>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_async_mqtt_header_only">async_mqtt (header-only)</h4>
<div class="sect4">
<h5 id="_async_mqtt_header_only">async_mqtt (header-only)</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>time make check_async_mqtt
Expand All @@ -418,8 +447,8 @@ <h4 id="_async_mqtt_header_only">async_mqtt (header-only)</h4>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_async_mqtt_separate_compilation_mode_library_part">async_mqtt (separate-compilation-mode) library part</h4>
<div class="sect4">
<h5 id="_async_mqtt_separate_compilation_mode_library_part">async_mqtt (separate-compilation-mode) library part</h5>
<div class="paragraph">
<p>Separate compilation library part (<strong>only once build required</strong>).</p>
</div>
Expand All @@ -433,8 +462,8 @@ <h4 id="_async_mqtt_separate_compilation_mode_library_part">async_mqtt (separate
</div>
</div>
</div>
<div class="sect3">
<h4 id="_async_mqtt_separate_compilation_mode_user_code_part">async_mqtt (separate-compilation-mode) user code part</h4>
<div class="sect4">
<h5 id="_async_mqtt_separate_compilation_mode_user_code_part">async_mqtt (separate-compilation-mode) user code part</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>time make check_async_mqtt_separate
Expand All @@ -447,10 +476,10 @@ <h4 id="_async_mqtt_separate_compilation_mode_user_code_part">async_mqtt (separa
</div>
</div>
</div>
<div class="sect2">
<h3 id="_compilation_time_size_optimization_os">Compilation time (size optimization (-Os))</h3>
<div class="sect3">
<h4 id="_async_mqtt5_header_only_2">async-mqtt5 (header-only)</h4>
<h4 id="_compilation_time_size_optimization_os">Compilation time (size optimization (-Os))</h4>
<div class="sect4">
<h5 id="_async_mqtt5_header_only_2">async-mqtt5 (header-only)</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>time make check_async-mqtt5
Expand All @@ -461,8 +490,8 @@ <h4 id="_async_mqtt5_header_only_2">async-mqtt5 (header-only)</h4>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_async_mqtt_header_only_2">async_mqtt (header-only)</h4>
<div class="sect4">
<h5 id="_async_mqtt_header_only_2">async_mqtt (header-only)</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>time make check_async_mqtt
Expand All @@ -473,8 +502,8 @@ <h4 id="_async_mqtt_header_only_2">async_mqtt (header-only)</h4>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_async_mqtt_separate_compilation_mode_library_part_2">async_mqtt (separate-compilation-mode) library part</h4>
<div class="sect4">
<h5 id="_async_mqtt_separate_compilation_mode_library_part_2">async_mqtt (separate-compilation-mode) library part</h5>
<div class="paragraph">
<p>Separate compilation library part (<strong>only once build required</strong>).</p>
</div>
Expand All @@ -488,8 +517,8 @@ <h4 id="_async_mqtt_separate_compilation_mode_library_part_2">async_mqtt (separa
</div>
</div>
</div>
<div class="sect3">
<h4 id="_async_mqtt_separate_compilation_mode_user_code_part_2">async_mqtt (separate-compilation-mode) user code part</h4>
<div class="sect4">
<h5 id="_async_mqtt_separate_compilation_mode_user_code_part_2">async_mqtt (separate-compilation-mode) user code part</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>time make check_async_mqtt_separate
Expand All @@ -502,10 +531,10 @@ <h4 id="_async_mqtt_separate_compilation_mode_user_code_part_2">async_mqtt (sepa
</div>
</div>
</div>
<div class="sect2">
<h3 id="_memory_consumption_size_optimization_os">Memory consumption size optimization (-Os)</h3>
<div class="sect3">
<h4 id="_async_mqtt5_header_only_3">async-mqtt5 (header-only)</h4>
<h4 id="_memory_consumption_size_optimization_os">Memory consumption size optimization (-Os)</h4>
<div class="sect4">
<h5 id="_async_mqtt5_header_only_3">async-mqtt5 (header-only)</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>/usr/bin/time -v ./check_async-mqtt5
Expand Down Expand Up @@ -535,8 +564,8 @@ <h4 id="_async_mqtt5_header_only_3">async-mqtt5 (header-only)</h4>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_async_mqtt_header_only_3">async_mqtt (header-only)</h4>
<div class="sect4">
<h5 id="_async_mqtt_header_only_3">async_mqtt (header-only)</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>/usr/bin/time -v ./check_async_mqtt
Expand Down Expand Up @@ -566,8 +595,8 @@ <h4 id="_async_mqtt_header_only_3">async_mqtt (header-only)</h4>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_async_mqtt_separate_compilation_mode">async_mqtt (separate-compilation-mode)</h4>
<div class="sect4">
<h5 id="_async_mqtt_separate_compilation_mode">async_mqtt (separate-compilation-mode)</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code>/usr/bin/time -v ./check_async_mqtt_separate
Expand Down Expand Up @@ -618,9 +647,10 @@ <h4 id="_async_mqtt_separate_compilation_mode">async_mqtt (separate-compilation-
</div>
</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-06-18 21:33:46 +0900
Last updated 2024-06-19 10:06:10 +0900
</div>
</div>
</body>
Expand Down
16 changes: 14 additions & 2 deletions doc/config.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ <h2 id="_cmake">cmake</h2>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">ASYNC_MQTT_USE_WS</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Enables Websocket for tools (broker, bench, client_cli, &#8230;&#8203;) (compilation time becomes longer)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Enables Websocket for tools (broker, bench, client_cli, &#8230;&#8203;) (compilation time becomes longer). See <a href="#faster-compile">make faster compilation time</a>.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">ASYNC_MQTT_USE_LOG</p></td>
Expand Down Expand Up @@ -245,7 +245,7 @@ <h2 id="_c_preprocessor_macro">C++ preprocessor macro</h2>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">ASYNC_MQTT_USE_WS</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Enables Websockets (compilation time becomes longer)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Enables Websockets (compilation time becomes longer), See <a href="#faster-compile">make faster compilation time</a>.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">ASYNC_MQTT_USE_LOG</p></td>
Expand All @@ -255,8 +255,20 @@ <h2 id="_c_preprocessor_macro">C++ preprocessor macro</h2>
<td class="tableblock halign-left valign-top"><p class="tableblock">ASYNC_MQTT_PRINT_PAYLOAD</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Output payload when publish packet is output</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">ASYNC_MQTT_SEPARATE_COMPILATION</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Enables <a href="separate.html">Separate Compilation Mode</a></p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="faster-compile">Make faster compilation time</h2>
<div class="sectionbody">
<div class="paragraph">
<p><a href="separate.html">Separate Compilation Mode</a> for async_mqtt and <a href="https://www.boost.org/libs/beast/doc/html/beast/config/configuration_preprocessor_defin.html">Boost.Beast</a> would solve the long compilation time.</p>
</div>
<div id="navigation">
<table class="tableblock frame-none grid-none stretch">
<colgroup>
Expand Down

0 comments on commit 6bf6c1a

Please sign in to comment.