Skip to content

Commit

Permalink
Update user manual.
Browse files Browse the repository at this point in the history
  • Loading branch information
b2-bot committed May 28, 2024
1 parent 1a5ebfd commit 1192da4
Showing 1 changed file with 160 additions and 4 deletions.
164 changes: 160 additions & 4 deletions manual/main/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -995,6 +995,11 @@ <h1>B2 User Manual</h1>
<li><a href="#_version_4_0_0">14.30. Version 4.0.0</a></li>
</ul>
</li>
<li><a href="#b2.appendix">Appendix A: Licenses</a>
<ul class="sectlevel2">
<li><a href="#_mit_license">A.1. MIT License</a></li>
</ul>
</li>
</ul>
</div>
</div>
Expand Down Expand Up @@ -9411,7 +9416,115 @@ <h5 id="_b2version_less"><a class="anchor" href="#_b2version_less"></a><code>b2:
</div>
</div>
<div class="sect3">
<h4 id="bbv2.reference.modules.path"><a class="anchor" href="#bbv2.reference.modules.path"></a>6.5.8. path</h4>
<h4 id="_db_module"><a class="anchor" href="#_db_module"></a>6.5.8. <code>db</code> module.</h4>
<div class="paragraph">
<p>Classes and functions to manage structured data.</p>
</div>
<div class="sect4">
<h5 id="_b2property_db_property_db"><a class="anchor" href="#_b2property_db_property_db"></a><code>b2::property_db</code> (<code>property-db</code>)</h5>
<div class="paragraph">
<p>Container for values structured as a tree with keys that are the tree path to
the value. Arrays and objects (named fields) are supported.</p>
</div>
<div class="sect5">
<h6 id="_b2property_dbemplace"><a class="anchor" href="#_b2property_dbemplace"></a><code>b2::property_db::emplace</code></h6>
<div class="exampleblock">
<div class="content">
<div class="hdlist">
<table>
<tr>
<td class="hdlist1">
Jam
</td>
<td class="hdlist2">
<p><code>rule emplace ( key + : value )</code></p>
</td>
</tr>
<tr>
<td class="hdlist1">
C++
</td>
<td class="hdlist2">
<p><code>void emplace(list_cref k, value_ref v);</code></p>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="paragraph">
<p>Set, or add, element at path <code>key</code> with <code>value</code>. The path can contain two kinds
of position items: an array index or an object member. An array index is
<code>"[]" <em>n</em></code>. Where the <code>"[]"</code> indicates that a zero based index in the array,
<code><em>n</em></code> follows. Anything else is treated as a member field name.</p>
</div>
</div>
<div class="sect5">
<h6 id="_b2property_dbwrite_file"><a class="anchor" href="#_b2property_dbwrite_file"></a><code>b2::property_db::write_file</code></h6>
<div class="exampleblock">
<div class="content">
<div class="hdlist">
<table>
<tr>
<td class="hdlist1">
Jam
</td>
<td class="hdlist2">
<p><code>rule write-file ( filename : format ? )</code></p>
</td>
</tr>
<tr>
<td class="hdlist1">
C++
</td>
<td class="hdlist2">
<p><code>void write_file(value_ref filename, value_ref format);</code></p>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="paragraph">
<p>Writes out a representation of the data to the given <code>filename</code> file formatted
as <code>format</code>. Supported formats are: <code>JSON</code>.</p>
</div>
</div>
<div class="sect5">
<h6 id="_b2property_dbdump"><a class="anchor" href="#_b2property_dbdump"></a><code>b2::property_db::dump</code></h6>
<div class="exampleblock">
<div class="content">
<div class="hdlist">
<table>
<tr>
<td class="hdlist1">
Jam
</td>
<td class="hdlist2">
<p><code>rule dump ( format ? )</code></p>
</td>
</tr>
<tr>
<td class="hdlist1">
C++
</td>
<td class="hdlist2">
<p><code>std::string dump(value_ref format);</code></p>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="paragraph">
<p>Writes out a representation of the data as a string formatted as <code>format</code>.
Supported formats are: <code>JSON</code>.</p>
</div>
</div>
</div>
</div>
<div class="sect3">
<h4 id="bbv2.reference.modules.path"><a class="anchor" href="#bbv2.reference.modules.path"></a>6.5.9. path</h4>
<div class="paragraph">
<p>Performs various path manipulations. Paths are always in a 'normalized'
representation. In it, a path may be either:</p>
Expand Down Expand Up @@ -9594,7 +9707,7 @@ <h4 id="bbv2.reference.modules.path"><a class="anchor" href="#bbv2.reference.mod
</div>
</div>
<div class="sect3">
<h4 id="bbv2.reference.modules.sequence"><a class="anchor" href="#bbv2.reference.modules.sequence"></a>6.5.9. sequence</h4>
<h4 id="bbv2.reference.modules.sequence"><a class="anchor" href="#bbv2.reference.modules.sequence"></a>6.5.10. sequence</h4>
<div class="paragraph">
<p>Various useful list functions. Note that algorithms in this module
execute largely in the caller&#8217;s module namespace, so that local rules
Expand Down Expand Up @@ -9675,7 +9788,7 @@ <h4 id="bbv2.reference.modules.sequence"><a class="anchor" href="#bbv2.reference
</div>
</div>
<div class="sect3">
<h4 id="bbv2.reference.modules.stage"><a class="anchor" href="#bbv2.reference.modules.stage"></a>6.5.10. stage</h4>
<h4 id="bbv2.reference.modules.stage"><a class="anchor" href="#bbv2.reference.modules.stage"></a>6.5.11. stage</h4>
<div class="paragraph">
<p>This module defines the <code>install</code> rule, used to copy a set of targets to a
single location.</p>
Expand Down Expand Up @@ -9794,7 +9907,7 @@ <h4 id="bbv2.reference.modules.stage"><a class="anchor" href="#bbv2.reference.mo
</div>
</div>
<div class="sect3">
<h4 id="bbv2.reference.modules.type"><a class="anchor" href="#bbv2.reference.modules.type"></a>6.5.11. type</h4>
<h4 id="bbv2.reference.modules.type"><a class="anchor" href="#bbv2.reference.modules.type"></a>6.5.12. type</h4>
<div class="paragraph">
<p>Deals with target type declaration and defines target class which
supports typed targets.</p>
Expand Down Expand Up @@ -17878,6 +17991,49 @@ <h3 id="_version_4_0_0"><a class="anchor" href="#_version_4_0_0"></a>14.30. Vers
</div>
</div>
</div>
<div class="sect1">
<h2 id="b2.appendix"><a class="anchor" href="#b2.appendix"></a>Appendix A: Licenses</h2>
<div class="sectionbody">
<div class="paragraph">
<p>In addition to B2 being licensed under the Boost Software License - Version 1.0,
B2 makes use of additional libraries that are differently licensed as follows.</p>
</div>
<div class="sect2">
<h3 id="_mit_license"><a class="anchor" href="#_mit_license"></a>A.1. MIT License</h3>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-jam" data-lang="jam">MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.</code></pre>
</div>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1"><a href="https://github.com/nlohmann/json">JSON for Modern C++</a></dt>
<dd>
<p>Copyright (c) 2013-2022 Niels Lohmann</p>
</dd>
</dl>
</div>
</div>
</div>
</div>
</div>
<div id="footnotes">
<hr>
Expand Down

0 comments on commit 1192da4

Please sign in to comment.