Auto-deployed update of 'docs/' for 'refs/heads/docs'

xnvme · May 31, 2024 · 8ba3e94 · 8ba3e94
1 parent 04c1704
commit 8ba3e94
Show file tree

Hide file tree

Showing 175 changed files with 1,388 additions and 2,985 deletions.
diff --git a/.doctrees/api/core/index.doctree b/.doctrees/api/core/index.doctree
diff --git a/.doctrees/api/core/xnvme_adm.doctree b/.doctrees/api/core/xnvme_adm.doctree
diff --git a/.doctrees/api/core/xnvme_buf.doctree b/.doctrees/api/core/xnvme_buf.doctree
diff --git a/.doctrees/api/core/xnvme_cmd.doctree b/.doctrees/api/core/xnvme_cmd.doctree
diff --git a/.doctrees/api/core/xnvme_dev.doctree b/.doctrees/api/core/xnvme_dev.doctree
diff --git a/.doctrees/api/core/xnvme_nvm.doctree b/.doctrees/api/core/xnvme_nvm.doctree
diff --git a/.doctrees/api/core/xnvme_queue.doctree b/.doctrees/api/core/xnvme_queue.doctree
diff --git a/.doctrees/api/examples/index.doctree b/.doctrees/api/examples/index.doctree
diff --git a/.doctrees/api/extended/index.doctree b/.doctrees/api/extended/index.doctree
diff --git a/.doctrees/api/extended/xnvme_be.doctree b/.doctrees/api/extended/xnvme_be.doctree
diff --git a/.doctrees/api/extended/xnvme_cli.doctree b/.doctrees/api/extended/xnvme_cli.doctree
diff --git a/.doctrees/api/extended/xnvme_file.doctree b/.doctrees/api/extended/xnvme_file.doctree
diff --git a/.doctrees/api/extended/xnvme_geo.doctree b/.doctrees/api/extended/xnvme_geo.doctree
diff --git a/.doctrees/api/extended/xnvme_ident.doctree b/.doctrees/api/extended/xnvme_ident.doctree
diff --git a/.doctrees/api/extended/xnvme_kvs.doctree b/.doctrees/api/extended/xnvme_kvs.doctree
diff --git a/.doctrees/api/extended/xnvme_lba.doctree b/.doctrees/api/extended/xnvme_lba.doctree
diff --git a/.doctrees/api/extended/xnvme_libconf.doctree b/.doctrees/api/extended/xnvme_libconf.doctree
diff --git a/.doctrees/api/extended/xnvme_mem.doctree b/.doctrees/api/extended/xnvme_mem.doctree
diff --git a/.doctrees/api/extended/xnvme_opts.doctree b/.doctrees/api/extended/xnvme_opts.doctree
diff --git a/.doctrees/api/extended/xnvme_pi.doctree b/.doctrees/api/extended/xnvme_pi.doctree
diff --git a/.doctrees/api/extended/xnvme_pp.doctree b/.doctrees/api/extended/xnvme_pp.doctree
diff --git a/.doctrees/api/extended/xnvme_spec.doctree b/.doctrees/api/extended/xnvme_spec.doctree
diff --git a/.doctrees/api/extended/xnvme_spec_fs.doctree b/.doctrees/api/extended/xnvme_spec_fs.doctree
diff --git a/.doctrees/api/extended/xnvme_spec_pp.doctree b/.doctrees/api/extended/xnvme_spec_pp.doctree
diff --git a/.doctrees/api/extended/xnvme_topology.doctree b/.doctrees/api/extended/xnvme_topology.doctree
diff --git a/.doctrees/api/extended/xnvme_util.doctree b/.doctrees/api/extended/xnvme_util.doctree
diff --git a/.doctrees/api/extended/xnvme_ver.doctree b/.doctrees/api/extended/xnvme_ver.doctree
diff --git a/.doctrees/api/extended/xnvme_znd.doctree b/.doctrees/api/extended/xnvme_znd.doctree
diff --git a/.doctrees/api/index.doctree b/.doctrees/api/index.doctree
diff --git a/.doctrees/api/python/index.doctree b/.doctrees/api/python/index.doctree
diff --git a/.doctrees/api/rust/index.doctree b/.doctrees/api/rust/index.doctree
diff --git a/.doctrees/backends/build_windows.doctree b/.doctrees/backends/build_windows.doctree
diff --git a/.doctrees/backends/index.doctree b/.doctrees/backends/index.doctree
diff --git a/.doctrees/backends/system.doctree b/.doctrees/backends/system.doctree
diff --git a/.doctrees/backends/xnvme_be_fbsd.doctree b/.doctrees/backends/xnvme_be_fbsd.doctree
diff --git a/.doctrees/backends/xnvme_be_intf.doctree b/.doctrees/backends/xnvme_be_intf.doctree
diff --git a/.doctrees/backends/xnvme_be_linux.doctree b/.doctrees/backends/xnvme_be_linux.doctree
diff --git a/.doctrees/backends/xnvme_be_spdk/index.doctree b/.doctrees/backends/xnvme_be_spdk/index.doctree
diff --git a/.doctrees/backends/xnvme_be_windows.doctree b/.doctrees/backends/xnvme_be_windows.doctree
diff --git a/.doctrees/contributing/assumptions.doctree b/.doctrees/contributing/assumptions.doctree
diff --git a/.doctrees/contributing/ci/bench/index.doctree b/.doctrees/contributing/ci/bench/index.doctree
diff --git a/.doctrees/contributing/ci/index.doctree b/.doctrees/contributing/ci/index.doctree
diff --git a/.doctrees/contributing/ci/verify/index.doctree b/.doctrees/contributing/ci/verify/index.doctree
diff --git a/.doctrees/contributing/contributing-branches.doctree b/.doctrees/contributing/contributing-branches.doctree
diff --git a/.doctrees/contributing/contributing-conventions.doctree b/.doctrees/contributing/contributing-conventions.doctree
diff --git a/.doctrees/contributing/contributing-process.doctree b/.doctrees/contributing/contributing-process.doctree
diff --git a/.doctrees/contributing/contributing-toolbox.doctree b/.doctrees/contributing/contributing-toolbox.doctree
diff --git a/.doctrees/contributing/index.doctree b/.doctrees/contributing/index.doctree
diff --git a/.doctrees/contributing/packaging/aur/index.doctree b/.doctrees/contributing/packaging/aur/index.doctree
diff --git a/.doctrees/contributing/packaging/brew/index.doctree b/.doctrees/contributing/packaging/brew/index.doctree
diff --git a/.doctrees/contributing/packaging/index.doctree b/.doctrees/contributing/packaging/index.doctree
diff --git a/.doctrees/contributing/packaging/windows/index.doctree b/.doctrees/contributing/packaging/windows/index.doctree
diff --git a/.doctrees/contributing/release-checklist.doctree b/.doctrees/contributing/release-checklist.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/getting_started/build_meson.doctree b/.doctrees/getting_started/build_meson.doctree
diff --git a/.doctrees/getting_started/build_windows.doctree b/.doctrees/getting_started/build_windows.doctree
diff --git a/.doctrees/getting_started/building.doctree b/.doctrees/getting_started/building.doctree
diff --git a/.doctrees/getting_started/clone.doctree b/.doctrees/getting_started/clone.doctree
diff --git a/.doctrees/getting_started/example.doctree b/.doctrees/getting_started/example.doctree
diff --git a/.doctrees/getting_started/index.doctree b/.doctrees/getting_started/index.doctree
diff --git a/.doctrees/getting_started/toolchain.doctree b/.doctrees/getting_started/toolchain.doctree
diff --git a/.doctrees/getting_started/troubleshooting.doctree b/.doctrees/getting_started/troubleshooting.doctree
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/material/index.doctree b/.doctrees/material/index.doctree
diff --git a/.doctrees/tools/file/index.doctree b/.doctrees/tools/file/index.doctree
diff --git a/.doctrees/tools/fio/index.doctree b/.doctrees/tools/fio/index.doctree
diff --git a/.doctrees/tools/index.doctree b/.doctrees/tools/index.doctree
diff --git a/.doctrees/tools/lblk/index.doctree b/.doctrees/tools/lblk/index.doctree
diff --git a/.doctrees/tools/xdd/index.doctree b/.doctrees/tools/xdd/index.doctree
diff --git a/.doctrees/tools/xnvme/enum/index.doctree b/.doctrees/tools/xnvme/enum/index.doctree
diff --git a/.doctrees/tools/xnvme/feature-get/index.doctree b/.doctrees/tools/xnvme/feature-get/index.doctree
diff --git a/.doctrees/tools/xnvme/feature-set/index.doctree b/.doctrees/tools/xnvme/feature-set/index.doctree
diff --git a/.doctrees/tools/xnvme/format/index.doctree b/.doctrees/tools/xnvme/format/index.doctree
diff --git a/.doctrees/tools/xnvme/idfy-ctrlr/index.doctree b/.doctrees/tools/xnvme/idfy-ctrlr/index.doctree
diff --git a/.doctrees/tools/xnvme/idfy-ns/index.doctree b/.doctrees/tools/xnvme/idfy-ns/index.doctree
diff --git a/.doctrees/tools/xnvme/idfy/index.doctree b/.doctrees/tools/xnvme/idfy/index.doctree
diff --git a/.doctrees/tools/xnvme/index.doctree b/.doctrees/tools/xnvme/index.doctree
diff --git a/.doctrees/tools/xnvme/info/index.doctree b/.doctrees/tools/xnvme/info/index.doctree
diff --git a/.doctrees/tools/xnvme/log-erri/index.doctree b/.doctrees/tools/xnvme/log-erri/index.doctree
diff --git a/.doctrees/tools/xnvme/log-health/index.doctree b/.doctrees/tools/xnvme/log-health/index.doctree
diff --git a/.doctrees/tools/xnvme/log/index.doctree b/.doctrees/tools/xnvme/log/index.doctree
diff --git a/.doctrees/tools/xnvme/padc/index.doctree b/.doctrees/tools/xnvme/padc/index.doctree
diff --git a/.doctrees/tools/xnvme/pioc/index.doctree b/.doctrees/tools/xnvme/pioc/index.doctree
diff --git a/.doctrees/tools/xnvme/sanitize/index.doctree b/.doctrees/tools/xnvme/sanitize/index.doctree
diff --git a/.doctrees/tools/zoned/index.doctree b/.doctrees/tools/zoned/index.doctree
diff --git a/.doctrees/tutorial/devs/index.doctree b/.doctrees/tutorial/devs/index.doctree
diff --git a/.doctrees/tutorial/dynamic_loading/index.doctree b/.doctrees/tutorial/dynamic_loading/index.doctree
diff --git a/.doctrees/tutorial/fabrics/index.doctree b/.doctrees/tutorial/fabrics/index.doctree
diff --git a/.doctrees/tutorial/fdp/index.doctree b/.doctrees/tutorial/fdp/index.doctree
diff --git a/.doctrees/tutorial/index.doctree b/.doctrees/tutorial/index.doctree
diff --git a/_sources/contributing/contributing-process.rst.txt b/_sources/contributing/contributing-process.rst.txt
@@ -1,7 +1,7 @@
 .. _sec-contributing-process:
 
 Contribution Process
-====================
+####################
 
 * `Fork`_ the **xNVMe** repository on `GitHUB`_
 
@@ -13,16 +13,16 @@ Contribution Process
 * The CI will trigger as you create the PR and re-triggered upon update
 
   - The default CI-jobs consists of running style/linters and building xNVMe
-  - When ready for integration it will be marked ``pr-ready-for-test`` and a
-    larger suite of functional tests are triggered
+  - Average time for a full functional verification run is about 40min
+  - One manual CI-job is triggered via the label ``bench``
 
 * Go over the :ref:`sec-contributing-process-pr-checklist` and re-iterate on
   your pull-request / changes
 
 .. _sec-contributing-process-pr-checklist:
 
 Pull-Request Checklist
-----------------------
+======================
 
 Please check your pull-request for the following:
 
@@ -45,26 +45,21 @@ Please check your pull-request for the following:
 .. _sec-contributing-process-commit-messages:
 
 Commit Messages
----------------
+===============
+
+Messages must follow the :xref-conventional-commits:`Conventional Commits<>`
+specification. And in addition, for readability:
 
 1. The first line is subject/title
 
    - Keep it at a max. of 72 chars, if possible
    - Lower-case is preferred
    - Do **not** end with a punctuation
    - Use the **imperative mood** e.g. ``add`` rather than ``added``/``adds``
-   - Prefix with the component(s) e.g. ``component: ...``
-
-     - If the commit touches the API (``libxnvme*.h``), then prefix with
-       ``api:``
-     - If the commit touches a backend, then prefix with specific backend e.g.
-       ``be/linux: ...``
-     - If the commit touches a "core" component, then prefix that, e.g.
-       ``buf: ...``, ``ident: ...``
-     - In case of multiple components, then separate with a comma e.g.
-       ``ident,be/linux: ...```
-
-   - **Example**: ``be/libaio: add spin-while-waiting for opts.poll_io``
+   - A couple of examples:
+    - ``feat(be/ramdisk): add support for compare``
+    - ``feat(build): bump libvfn to v4.0.1``
+    - ``refactor(docs): move toolchain section down after troubleshooting``
 
 2. Then an empty line.
 
@@ -81,8 +76,8 @@ Commit Messages
    - By adding ``Signed-off-by``, you indicate that you agree to the `DCO`_
 
 Take a look at the commit history (``git log --follow <files>``), for the files
-you are changing, that should give you an idea of the "component" prefix(es) as
-well as the other items on the list above.
+you are changing, that should give you an idea of the "component" as well as the
+other items on the list above.
 
 .. _Discord: https://discord.com/invite/XCbBX9DmKf
 .. _Fork: https://github.com/xnvme/xnvme/fork

diff --git a/_sources/contributing/index.rst.txt b/_sources/contributing/index.rst.txt
@@ -1,8 +1,8 @@
 .. _sec-contributing:
 
-==============
+##############
  Contributing
-==============
+##############
 
 **xNVMe** is hosted on :xref-github-xnvme:`GitHub<>`
 where you can raise :xref-github-xnvme-issues:`issue<>`,

diff --git a/api/core/xnvme_adm.html b/api/core/xnvme_adm.html
@@ -626,7 +626,7 @@
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>ctx</strong> – Pointer to <a class="reference internal" href="xnvme_cmd.html#structxnvme__cmd__ctx"><span class="std std-ref">xnvme_cmd_ctx</span></a></p></li>
 <li><p><strong>csi</strong> – Command Set Identifier </p></li>
-<li><p><strong>dbuf</strong> – Buffer allocated by <a class="reference internal" href="xnvme_buf.html#libxnvme__buf_8h_1af9e041abbb8bb79c853a3907acfabb43"><span class="std std-ref">xnvme_buf_alloc()</span></a></p></li>
+<li><p><strong>dbuf</strong> – Buffer allocated by <a class="reference internal" href="xnvme_buf.html#libxnvme__buf_8h_1aa61c331982922d038a6af22fbe4e1a1a"><span class="std std-ref">xnvme_buf_alloc()</span></a></p></li>
 </ul>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
@@ -648,7 +648,7 @@
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>ctx</strong> – Pointer to <a class="reference internal" href="xnvme_cmd.html#structxnvme__cmd__ctx"><span class="std std-ref">xnvme_cmd_ctx</span></a></p></li>
 <li><p><strong>nsid</strong> – Namespace identifier </p></li>
-<li><p><strong>dbuf</strong> – Buffer allocated by <a class="reference internal" href="xnvme_buf.html#libxnvme__buf_8h_1af9e041abbb8bb79c853a3907acfabb43"><span class="std std-ref">xnvme_buf_alloc()</span></a></p></li>
+<li><p><strong>dbuf</strong> – Buffer allocated by <a class="reference internal" href="xnvme_buf.html#libxnvme__buf_8h_1aa61c331982922d038a6af22fbe4e1a1a"><span class="std std-ref">xnvme_buf_alloc()</span></a></p></li>
 </ul>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
@@ -671,7 +671,7 @@
 <li><p><strong>ctx</strong> – Pointer to <a class="reference internal" href="xnvme_cmd.html#structxnvme__cmd__ctx"><span class="std std-ref">xnvme_cmd_ctx</span></a></p></li>
 <li><p><strong>nsid</strong> – Namespace identifier </p></li>
 <li><p><strong>csi</strong> – Command Set Identifier </p></li>
-<li><p><strong>dbuf</strong> – Buffer allocated by <a class="reference internal" href="xnvme_buf.html#libxnvme__buf_8h_1af9e041abbb8bb79c853a3907acfabb43"><span class="std std-ref">xnvme_buf_alloc()</span></a></p></li>
+<li><p><strong>dbuf</strong> – Buffer allocated by <a class="reference internal" href="xnvme_buf.html#libxnvme__buf_8h_1aa61c331982922d038a6af22fbe4e1a1a"><span class="std std-ref">xnvme_buf_alloc()</span></a></p></li>
 </ul>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>