Skip to content

Commit

Permalink
Auto-deployed update of 'docs/' for 'refs/heads/next'
Browse files Browse the repository at this point in the history
  • Loading branch information
ghs-safl committed Jul 16, 2024
1 parent 6296dac commit ce7679e
Show file tree
Hide file tree
Showing 10 changed files with 39 additions and 39 deletions.
Binary file modified en/next/.doctrees/environment.pickle
Binary file not shown.
Binary file modified en/next/.doctrees/getting_started/toolchain.doctree
Binary file not shown.
Binary file modified en/next/.doctrees/getting_started/troubleshooting.doctree
Binary file not shown.
Binary file modified en/next/.doctrees/tutorial/fdp/index.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion en/next/_sources/getting_started/troubleshooting.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ to musl standard library not being entirely compatible with **GLIBC** /
The SPDK backend does not build on due to re-definition of ``STAILQ_*``
macros. As a work-around, then disable the SPDK backend::

meson setup builddir -Dwith-spdk=false
meson setup builddir -Dwith-spdk=disabled

The Linux backend support for ``io_uring`` fails on **Alpine Linux** due to a
missing definition in **musl** leading to this error message::
Expand Down
4 changes: 2 additions & 2 deletions en/next/getting_started/toolchain.html
Original file line number Diff line number Diff line change
Expand Up @@ -545,7 +545,7 @@ <h2>Alpine Linux (latest)<a class="headerlink" href="#alpine-linux-latest" title
</div>
<p>Then go ahead and configure, build and install using <code class="docutils literal notranslate"><span class="pre">meson</span></code>:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># configure xNVMe with SPDK and libvfn disabled</span>
meson<span class="w"> </span>setup<span class="w"> </span>builddir<span class="w"> </span>-Dwith-spdk<span class="o">=</span><span class="nb">false</span>
meson<span class="w"> </span>setup<span class="w"> </span>builddir<span class="w"> </span>-Dwith-spdk<span class="o">=</span>disabled

<span class="c1"># build xNVMe</span>
meson<span class="w"> </span>compile<span class="w"> </span>-C<span class="w"> </span>builddir
Expand Down Expand Up @@ -2093,6 +2093,7 @@ <h2>FreeBSD (13)<a class="headerlink" href="#freebsd-13" title="Link to this hea
<span class="w"> </span>automake<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>bash<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>cunit<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>devel/py-pipx<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>devel/py-pyelftools<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>e2fsprogs-libuuid<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>findutils<span class="w"> </span><span class="se">\</span>
Expand All @@ -2106,7 +2107,6 @@ <h2>FreeBSD (13)<a class="headerlink" href="#freebsd-13" title="Link to this hea
<span class="w"> </span>openssl<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>patch<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>pkgconf<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>py39-pipx<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>python3<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>wget

Expand Down
2 changes: 1 addition & 1 deletion en/next/getting_started/troubleshooting.html
Original file line number Diff line number Diff line change
Expand Up @@ -518,7 +518,7 @@ <h2>Known Build Issues<a class="headerlink" href="#known-build-issues" title="Li
<strong>BSD</strong>.</p>
<p>The SPDK backend does not build on due to re-definition of <code class="docutils literal notranslate"><span class="pre">STAILQ_*</span></code>
macros. As a work-around, then disable the SPDK backend:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">meson</span> <span class="n">setup</span> <span class="n">builddir</span> <span class="o">-</span><span class="n">Dwith</span><span class="o">-</span><span class="n">spdk</span><span class="o">=</span><span class="n">false</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">meson</span> <span class="n">setup</span> <span class="n">builddir</span> <span class="o">-</span><span class="n">Dwith</span><span class="o">-</span><span class="n">spdk</span><span class="o">=</span><span class="n">disabled</span>
</pre></div>
</div>
<p>The Linux backend support for <code class="docutils literal notranslate"><span class="pre">io_uring</span></code> fails on <strong>Alpine Linux</strong> due to a
Expand Down
40 changes: 20 additions & 20 deletions en/next/output.json
Original file line number Diff line number Diff line change
Expand Up @@ -118,61 +118,61 @@
{"filename": "backends/index.rst", "lineno": 89, "status": "working", "code": 0, "uri": "https://blog.linuxplumbersconf.org/2009/slides/Anthony-Liguori-qemu-block.pdf", "info": ""}
{"filename": "backends/index.rst", "lineno": 89, "status": "working", "code": 0, "uri": "http://www.cs.cmu.edu/~riedel/ftp/SIO/API/cmu-cs-96-193.pdf", "info": ""}
{"filename": "contributing/release-checklist.rst", "lineno": 77, "status": "working", "code": 0, "uri": "https://crates.io", "info": ""}
{"filename": "contributing/ci/index.rst", "lineno": 30, "status": "redirected", "code": 302, "uri": "https://cijoe.readthedocs.io", "info": "https://cijoe.readthedocs.io/en/latest/"}
{"filename": "contributing/contributing-process.rst", "lineno": 81, "status": "working", "code": 0, "uri": "https://developercertificate.org/", "info": ""}
{"filename": "contributing/index.rst", "lineno": 16, "status": "working", "code": 0, "uri": "https://discord.com/invite/XCbBX9DmKf", "info": ""}
{"filename": "contributing/ci/index.rst", "lineno": 30, "status": "redirected", "code": 302, "uri": "https://cijoe.readthedocs.io", "info": "https://cijoe.readthedocs.io/en/latest/"}
{"filename": "api/python/index.rst", "lineno": 7, "status": "working", "code": 0, "uri": "https://docs.python.org/3/library/ctypes.html", "info": ""}
{"filename": "api/python/index.rst", "lineno": 31, "status": "working", "code": 0, "uri": "https://en.wikipedia.org/wiki/CPython", "info": ""}
{"filename": "contributing/ci/bench/index.rst", "lineno": 37, "status": "working", "code": 0, "uri": "https://docs.netgate.com/pfsense/en/latest/solutions/sg-1100/", "info": ""}
{"filename": "contributing/ci/bench/index.rst", "lineno": 61, "status": "working", "code": 0, "uri": "https://docs.pikvm.org/v3/", "info": ""}
{"filename": "contributing/packaging/index.rst", "lineno": 30, "status": "working", "code": 0, "uri": "https://copr.fedorainfracloud.org/coprs/karlowich/xNVMe/", "info": ""}
{"filename": "contributing/contributing-toolbox.rst", "lineno": 34, "status": "working", "code": 0, "uri": "https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks", "info": ""}
{"filename": "contributing/ci/bench/index.rst", "lineno": 61, "status": "working", "code": 0, "uri": "https://docs.pikvm.org/v3/", "info": ""}
{"filename": "contributing/packaging/index.rst", "lineno": 20, "status": "working", "code": 0, "uri": "https://formulae.brew.sh/formula/xnvme", "info": ""}
{"filename": "contributing/packaging/index.rst", "lineno": 30, "status": "working", "code": 0, "uri": "https://copr.fedorainfracloud.org/coprs/karlowich/xNVMe/", "info": ""}
{"filename": "contributing/ci/index.rst", "lineno": 21, "status": "working", "code": 0, "uri": "https://github.com/features/actions", "info": ""}
{"filename": "contributing/packaging/index.rst", "lineno": 16, "status": "working", "code": 0, "uri": "https://aur.archlinux.org/packages/xnvme", "info": ""}
{"filename": "tools/fio/index.rst", "lineno": 6, "status": "working", "code": 0, "uri": "https://github.com/ankit-sam", "info": ""}
{"filename": "tutorial/fdp/index.rst", "lineno": 194, "status": "working", "code": 0, "uri": "https://github.com/axboe/fio/blob/master/examples/xnvme-fdp.fio", "info": ""}
{"filename": "contributing/ci/index.rst", "lineno": 21, "status": "working", "code": 0, "uri": "https://github.com/features/actions", "info": ""}
{"filename": "tools/fio/index.rst", "lineno": 6, "status": "working", "code": 0, "uri": "https://github.com/axboe/fio", "info": ""}
{"filename": "api/python/index.rst", "lineno": 113, "status": "working", "code": 0, "uri": "https://github.com/trolldbois/ctypeslib/", "info": ""}
{"filename": "tools/fio/index.rst", "lineno": 6, "status": "working", "code": 0, "uri": "https://github.com/vincentkfu", "info": ""}
{"filename": "api/python/index.rst", "lineno": 113, "status": "working", "code": 0, "uri": "https://github.com/psf/black", "info": ""}
{"filename": "tools/fio/index.rst", "lineno": 9, "status": "working", "code": 0, "uri": "https://github.com/vincentkfu/fio-blog/wiki/xNVMe-ioengine-Part-1", "info": ""}
{"filename": "api/python/index.rst", "lineno": 113, "status": "working", "code": 0, "uri": "https://github.com/trolldbois/ctypeslib/", "info": ""}
{"filename": "tools/fio/index.rst", "lineno": 10, "status": "working", "code": 0, "uri": "https://github.com/vincentkfu/fio-blog/wiki/xNVMe-ioengine-Part-2", "info": ""}
{"filename": "api/python/index.rst", "lineno": 165, "status": "working", "code": 0, "uri": "https://github.com/mesonbuild/meson/issues/7863", "info": ""}
{"filename": "contributing/ci/index.rst", "lineno": 28, "status": "working", "code": 0, "uri": "https://github.com/xnvme/dpdk-windows-drivers", "info": ""}
{"filename": "getting_started/building.rst", "lineno": 6, "status": "working", "code": 0, "uri": "https://github.com/xnvme/xnvme", "info": ""}
{"filename": "contributing/ci/index.rst", "lineno": 27, "status": "working", "code": 0, "uri": "https://github.com/xnvme/xnvme-docker", "info": ""}
{"filename": "api/python/index.rst", "lineno": 165, "status": "working", "code": 0, "uri": "https://github.com/mesonbuild/meson/issues/7863", "info": ""}
{"filename": "contributing/index.rst", "lineno": 7, "status": "working", "code": 0, "uri": "https://github.com/xnvme/xnvme/discussions", "info": ""}
{"filename": "contributing/ci/index.rst", "lineno": 26, "status": "working", "code": 0, "uri": "https://github.com/xnvme/xnvme.github.io", "info": ""}
{"filename": "contributing/ci/index.rst", "lineno": 25, "status": "working", "code": 0, "uri": "https://github.com/xnvme/xnvme/", "info": ""}
{"filename": "contributing/ci/index.rst", "lineno": 26, "status": "working", "code": 0, "uri": "https://github.com/xnvme/xnvme.github.io", "info": ""}
{"filename": "contributing/contributing-process.rst", "lineno": 6, "status": "redirected", "code": 302, "uri": "https://github.com/xnvme/xnvme/fork", "info": "https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fxnvme%2Fxnvme%2Ffork"}
{"filename": "contributing/contributing-process.rst", "lineno": 6, "status": "working", "code": 0, "uri": "https://github.com/xnvme/xnvme/issues", "info": ""}
{"filename": "contributing/packaging/index.rst", "lineno": 6, "status": "working", "code": 0, "uri": "https://github.com/xnvme/xnvme/issues/389", "info": ""}
{"filename": "contributing/index.rst", "lineno": 7, "status": "working", "code": 0, "uri": "https://github.com/xnvme/xnvme/issues/", "info": ""}
{"filename": "contributing/contributing-process.rst", "lineno": 8, "status": "working", "code": 0, "uri": "https://github.com/xnvme/xnvme/pulls", "info": ""}
{"filename": "contributing/index.rst", "lineno": 7, "status": "working", "code": 0, "uri": "https://github.com/xnvme/xnvme/pulls/", "info": ""}
{"filename": "getting_started/building.rst", "lineno": 28, "status": "working", "code": 0, "uri": "https://mesonbuild.com/Builtin-options.html", "info": ""}
{"filename": "contributing/packaging/index.rst", "lineno": 6, "status": "working", "code": 0, "uri": "https://github.com/xnvme/xnvme/issues/389", "info": ""}
{"filename": "contributing/contributing-toolbox.rst", "lineno": 18, "status": "working", "code": 0, "uri": "https://mesonbuild.com/", "info": ""}
{"filename": "contributing/ci/index.rst", "lineno": 30, "status": "working", "code": 0, "uri": "https://github.com/xnvme/xnvme/tree/main/cijoe", "info": ""}
{"filename": "getting_started/building.rst", "lineno": 28, "status": "working", "code": 0, "uri": "https://mesonbuild.com/Builtin-options.html", "info": ""}
{"filename": "tutorial/fdp/index.rst", "lineno": 32, "status": "working", "code": 0, "uri": "https://nvmexpress.org/wp-content/uploads/NVM-Express-2.0-Ratified-TPs_20230111.zip", "info": ""}
{"filename": "contributing/ci/index.rst", "lineno": 30, "status": "working", "code": 0, "uri": "https://github.com/xnvme/xnvme/tree/main/cijoe", "info": ""}
{"filename": "getting_started/troubleshooting.rst", "lineno": 58, "status": "working", "code": 0, "uri": "https://github.com/xnvme/xnvme/releases", "info": ""}
{"filename": "contributing/packaging/index.rst", "lineno": 34, "status": "working", "code": 0, "uri": "https://ports.freebsd.org/cgi/ports.cgi?query=xnvme", "info": ""}
{"filename": "contributing/contributing-toolbox.rst", "lineno": 10, "status": "working", "code": 0, "uri": "https://pre-commit.com/", "info": ""}
{"filename": "api/python/index.rst", "lineno": 155, "status": "working", "code": 0, "uri": "https://pypi.org/", "info": ""}
{"filename": "api/python/index.rst", "lineno": 164, "status": "working", "code": 0, "uri": "https://pypi.org/project/mesonpep517/", "info": ""}
{"filename": "contributing/contributing-toolbox.rst", "lineno": 10, "status": "working", "code": 0, "uri": "https://pre-commit.com/", "info": ""}
{"filename": "api/python/index.rst", "lineno": 31, "status": "redirected", "code": 302, "uri": "https://pytest.org/", "info": "https://docs.pytest.org/en/8.2.x/"}
{"filename": "contributing/packaging/index.rst", "lineno": 12, "status": "working", "code": 0, "uri": "https://pkgs.alpinelinux.org/packages?name=xnvme", "info": ""}
{"filename": "contributing/packaging/index.rst", "lineno": 34, "status": "working", "code": 0, "uri": "https://ports.freebsd.org/cgi/ports.cgi?query=xnvme", "info": ""}
{"filename": "contributing/ci/bench/index.rst", "lineno": 61, "status": "working", "code": 0, "uri": "https://pikvm.org/", "info": ""}
{"filename": "api/python/index.rst", "lineno": 31, "status": "redirected", "code": 302, "uri": "https://pytest.org/", "info": "https://docs.pytest.org/en/8.2.x/"}
{"filename": "tutorial/fabrics/index.rst", "lineno": 7, "status": "working", "code": 0, "uri": "https://nvmexpress.org/specifications/", "info": ""}
{"filename": "contributing/ci/bench/index.rst", "lineno": 91, "status": "working", "code": 0, "uri": "https://rockpi.org/rockpi4", "info": ""}
{"filename": "contributing/ci/bench/index.rst", "lineno": 61, "status": "working", "code": 0, "uri": "https://safl.dk/notebook/pikvm/", "info": ""}
{"filename": "tutorial/fabrics/index.rst", "lineno": 110, "status": "working", "code": 0, "uri": "https://spdk.io/doc/nvmf.html", "info": ""}
{"filename": "backends/system.rst", "lineno": 188, "status": "working", "code": 0, "uri": "https://spdk.io/", "info": ""}
{"filename": "backends/system.rst", "lineno": 176, "status": "working", "code": 0, "uri": "https://www.kernel.org/doc/Documentation/vfio.txt", "info": ""}
{"filename": "tutorial/fabrics/index.rst", "lineno": 110, "status": "working", "code": 0, "uri": "https://spdk.io/doc/nvmf.html", "info": ""}
{"filename": "contributing/ci/bench/index.rst", "lineno": 61, "status": "working", "code": 0, "uri": "https://safl.dk/notebook/pikvm/", "info": ""}
{"filename": "contributing/ci/bench/index.rst", "lineno": 91, "status": "working", "code": 0, "uri": "https://rockpi.org/rockpi4", "info": ""}
{"filename": "contributing/ci/bench/index.rst", "lineno": 26, "status": "working", "code": 0, "uri": "https://shop.netgate.com/products/1100-pfsense", "info": ""}
{"filename": "contributing/packaging/index.rst", "lineno": 24, "status": "working", "code": 0, "uri": "https://salsa.debian.org/safl/xnvme", "info": ""}
{"filename": "backends/index.rst", "lineno": 89, "status": "working", "code": 0, "uri": "https://www.nextplatform.com/2017/09/11/whats-bad-posix-io/", "info": ""}
{"filename": "backends/system.rst", "lineno": 176, "status": "working", "code": 0, "uri": "https://www.kernel.org/doc/Documentation/vfio.txt", "info": ""}
{"filename": "backends/system.rst", "lineno": 176, "status": "working", "code": 0, "uri": "https://www.kernel.org/doc/html/v4.14/driver-api/uio-howto.html", "info": ""}
{"filename": "contributing/ci/bench/index.rst", "lineno": 91, "status": "working", "code": 0, "uri": "https://www.armbian.com/", "info": ""}
{"filename": "api/python/index.rst", "lineno": 166, "status": "working", "code": 0, "uri": "https://thiblahute.gitlab.io/mesonpep517/", "info": ""}
{"filename": "backends/index.rst", "lineno": 89, "status": "working", "code": 0, "uri": "https://www.nextplatform.com/2017/09/11/whats-bad-posix-io/", "info": ""}
{"filename": "contributing/packaging/index.rst", "lineno": 24, "status": "working", "code": 0, "uri": "https://salsa.debian.org/safl/xnvme", "info": ""}
{"filename": "contributing/release-checklist.rst", "lineno": 50, "status": "working", "code": 0, "uri": "https://xnvme.io/en/next", "info": ""}
{"filename": "api/python/index.rst", "lineno": 166, "status": "working", "code": 0, "uri": "https://thiblahute.gitlab.io/mesonpep517/", "info": ""}
2 changes: 1 addition & 1 deletion en/next/searchindex.js

Large diffs are not rendered by default.

Loading

0 comments on commit ce7679e

Please sign in to comment.