Skip to content

Commit ffcbeba

Browse files
committed
deploy: f0e8d44
1 parent 524a8de commit ffcbeba

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

119 files changed

+774
-2200
lines changed

user/contributing.html

+13-2
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ <h1 class="menu-title">uutils Documentation</h1>
170170
<div id="content" class="content">
171171
<main>
172172
<!-- markdownlint-disable MD041 -->
173-
<!-- spell-checker:ignore reimplementing toybox RUNTEST -->
173+
<!-- spell-checker:ignore reimplementing toybox RUNTEST CARGOFLAGS nextest -->
174174
<h1 id="contributing-to-coreutils"><a class="header" href="#contributing-to-coreutils">Contributing to coreutils</a></h1>
175175
<p>Contributions are very welcome via Pull Requests. If you don't know where to
176176
start, take a look at the
@@ -266,6 +266,11 @@ <h3 id="testing-with-cargo"><a class="header" href="#testing-with-cargo">Testing
266266
<p>If you also want to test the core utilities:</p>
267267
<pre><code class="language-shell">cargo test -p uucore -p coreutils
268268
</code></pre>
269+
<p>Running the complete test suite might take a while. We use <a href="https://nexte.st/index.html">nextest</a> in
270+
the CI and you might want to try it out locally. It can speed up the execution time of the whole
271+
test run significantly if the cpu has multiple cores.</p>
272+
<pre><code class="language-shell">cargo nextest run --features unix --no-fail-fast
273+
</code></pre>
269274
<p>To debug:</p>
270275
<pre><code class="language-shell">gdb --args target/debug/coreutils ls
271276
(gdb) b ls.rs:79
@@ -284,6 +289,12 @@ <h3 id="testing-with-gnu-make"><a class="header" href="#testing-with-gnu-make">T
284289
<p>To include tests for unimplemented behavior:</p>
285290
<pre><code class="language-shell">make UTILS='UTILITY_1 UTILITY_2' SPEC=y test
286291
</code></pre>
292+
<p>To run tests with <code>nextest</code> just use the nextest target. Note you'll need to
293+
<a href="https://nexte.st/book/installation.html">install</a> <code>nextest</code> first. The <code>nextest</code> target accepts the
294+
same arguments like the default <code>test</code> target, so it's possible to pass arguments to <code>nextest run</code>
295+
via <code>CARGOFLAGS</code>:</p>
296+
<pre><code class="language-shell">make CARGOFLAGS='--no-fail-fast' UTILS='UTILITY_1 UTILITY_2' nextest
297+
</code></pre>
287298
<h3 id="run-busybox-tests"><a class="header" href="#run-busybox-tests">Run Busybox Tests</a></h3>
288299
<p>This testing functionality is only available on *nix operating systems and
289300
requires <code>make</code>.</p>
@@ -408,7 +419,7 @@ <h2 id="other-implementations"><a class="header" href="#other-implementations">O
408419
<li><a href="https://github.com/SerenityOS/serenity/tree/master/Userland/Utilities">SerenityOS</a></li>
409420
<li><a href="https://github.com/dspinellis/unix-history-repo">Initial Unix</a></li>
410421
</ul>
411-
<p>However, when reimplementing the tools/options in Rust, don't read their source codes
422+
<p>However, when reimplementing the tools/options in Rust, don't read their source codes
412423
when they are using reciprocal licenses (ex: GNU GPL, GNU LGPL, etc).</p>
413424
<h2 id="licensing"><a class="header" href="#licensing">Licensing</a></h2>
414425
<p>uutils is distributed under the terms of the MIT License; see the <code>LICENSE</code> file

0 commit comments

Comments
 (0)