This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/arrow-nanoarrow.git
The following commit(s) were added to refs/heads/asf-site by this push:
new f3cd3272 update documentation for tag main
f3cd3272 is described below
commit f3cd327212149914d1fa37c7502a117790a1ee08
Author: GitHub Actions <[email protected]>
AuthorDate: Tue Nov 19 16:34:11 2024 +0000
update documentation for tag main
---
main/.doctrees/environment.pickle | Bin 1515530 -> 1514798 bytes
main/.doctrees/index.doctree | Bin 30798 -> 30997 bytes
main/index.html | 19 ++++++++++++-------
main/r/pkgdown.yml | 2 +-
main/searchindex.js | 2 +-
5 files changed, 14 insertions(+), 9 deletions(-)
diff --git a/main/.doctrees/environment.pickle
b/main/.doctrees/environment.pickle
index 092cc43a..128c513a 100644
Binary files a/main/.doctrees/environment.pickle and
b/main/.doctrees/environment.pickle differ
diff --git a/main/.doctrees/index.doctree b/main/.doctrees/index.doctree
index 4cb010ba..78847514 100644
Binary files a/main/.doctrees/index.doctree and b/main/.doctrees/index.doctree
differ
diff --git a/main/index.html b/main/index.html
index f3c93bd4..6f42ec77 100644
--- a/main/index.html
+++ b/main/index.html
@@ -451,15 +451,19 @@ cmake<span class="w"> </span>..
cmake<span class="w"> </span>--build<span class="w"> </span>.
</pre></div>
</div>
-<p>Building nanoarrow with tests currently requires <a class="reference
external" href="https://arrow.apache.org/install/";>Arrow
-C++</a>. If installed via a system
-package manager like <code class="docutils literal notranslate"><span
class="pre">apt</span></code>, <code class="docutils literal notranslate"><span
class="pre">dnf</span></code>, or <code class="docutils literal
notranslate"><span class="pre">brew</span></code>, the tests can be
-built with:</p>
+<p>To build nanoarrow along with tests run:</p>
<div class="highlight-sh notranslate"><div
class="highlight"><pre><span></span>mkdir<span class="w"> </span>build<span
class="w"> </span><span class="o">&&</span><span class="w">
</span><span class="nb">cd</span><span class="w"> </span>build
cmake<span class="w"> </span>..<span class="w">
</span>-DNANOARROW_BUILD_TESTS<span class="o">=</span>ON
cmake<span class="w"> </span>--build<span class="w"> </span>.
</pre></div>
</div>
+<p>If you are able to install <a class="reference external"
href="https://arrow.apache.org/install/";>Arrow
+C++</a> you can enable more testing:</p>
+<div class="highlight-sh notranslate"><div
class="highlight"><pre><span></span>mkdir<span class="w"> </span>build<span
class="w"> </span><span class="o">&&</span><span class="w">
</span><span class="nb">cd</span><span class="w"> </span>build
+cmake<span class="w"> </span>..<span class="w">
</span>-DNANOARROW_BUILD_TESTS<span class="o">=</span>ON<span class="w">
</span>-DNANOARROW_BUILD_TESTS_WITH_ARROW<span class="o">=</span>ON
+cmake<span class="w"> </span>--build<span class="w"> </span>.
+</pre></div>
+</div>
<p>Tests can be run with <code class="docutils literal notranslate"><span
class="pre">ctest</span></code>.</p>
</section>
<section id="building-with-meson">
@@ -474,9 +478,10 @@ the Meson backend is an experimental feature you may also
wish to try.</p>
<div class="highlight-sh notranslate"><div
class="highlight"><pre><span></span>meson<span class="w"> </span>configure<span
class="w"> </span>-Dtests<span class="o">=</span><span
class="nb">true</span><span class="w"> </span>-Dbenchmarks<span
class="o">=</span><span class="nb">true</span>
</pre></div>
</div>
-<p>If Arrow is installed in a non-standard location on your system, you may
-need to pass the <code class="docutils literal notranslate"><span
class="pre">--pkg-config-path</span> <span class="pre"><path</span> <span
class="pre">to</span> <span class="pre">directory</span> <span
class="pre">with</span> <span class="pre">arrow.pc></span></code>
-argument to either the setup or configure steps above.</p>
+<p>You can enable better test coverage if Apache Arrow is installed on your
+system with <code class="docutils literal notranslate"><span
class="pre">-Dtest_with_arrow=true</span></code>. Depending on how you have
+installed Apache Arrow, you may also need to pass
+<code class="docutils literal notranslate"><span
class="pre">--pkg-config-path</span> <span class="pre"><path</span> <span
class="pre">to</span> <span class="pre">directory</span> <span
class="pre">with</span> <span class="pre">arrow.pc></span></code>.</p>
<p>With the above out of the way, the <code class="docutils literal
notranslate"><span class="pre">compile</span></code> command should take care
of the rest:</p>
<div class="highlight-sh notranslate"><div
class="highlight"><pre><span></span>meson<span class="w"> </span>compile
diff --git a/main/r/pkgdown.yml b/main/r/pkgdown.yml
index 36955608..ad6682d5 100644
--- a/main/r/pkgdown.yml
+++ b/main/r/pkgdown.yml
@@ -2,4 +2,4 @@ pandoc: 3.1.3
pkgdown: 2.1.1
pkgdown_sha: ~
articles: {}
-last_built: 2024-11-13T03:55Z
+last_built: 2024-11-19T16:33Z
diff --git a/main/searchindex.js b/main/searchindex.js
index 28921bdb..c39a5830 100644
--- a/main/searchindex.js
+++ b/main/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"API Reference": [[8, null]], "Array Stream
utilities": [[6, "array-stream-utilities"]], "Array Streams": [[3,
"array-streams"]], "Array streams": [[2, "array-streams"]], "Arrays": [[2,
"arrays"], [3, "arrays"]], "Arrow C Data Interface": [[5,
"arrow-c-data-interface"]], "Arrow C Device Interface": [[7,
"arrow-c-device-interface"]], "Arrow C data/nanoarrow interface basics": [[0,
"arrow-c-data-nanoarrow-interface-basics"]], "Bitmap utilities": [[5, "bitmap-
[...]
\ No newline at end of file
+Search.setIndex({"alltitles": {"API Reference": [[8, null]], "Array Stream
utilities": [[6, "array-stream-utilities"]], "Array Streams": [[3,
"array-streams"]], "Array streams": [[2, "array-streams"]], "Arrays": [[2,
"arrays"], [3, "arrays"]], "Arrow C Data Interface": [[5,
"arrow-c-data-interface"]], "Arrow C Device Interface": [[7,
"arrow-c-device-interface"]], "Arrow C data/nanoarrow interface basics": [[0,
"arrow-c-data-nanoarrow-interface-basics"]], "Bitmap utilities": [[5, "bitmap-
[...]
\ No newline at end of file
