Skip to content

Commit 4ff3494

Browse files
committed
update of the docs
1 parent 1e8f868 commit 4ff3494

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

.vscode/cspell.dictionaries/workspace.wordlist.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -325,13 +325,15 @@ libc
325325
libstdbuf
326326
musl
327327
tmpd
328+
uchild
328329
ucmd
329330
ucommand
330331
utmpx
331332
uucore
332333
uucore_procs
333334
uudoc
334335
uumain
336+
uutests
335337
uutil
336338
uutils
337339

CONTRIBUTING.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,13 @@ parts for getting started:
3131

3232
- [`src/uu`](./src/uu/): The code for all utilities
3333
- [`src/uucore`](./src/uucore/): Crate containing all the shared code between
34-
the utilities.
34+
the utilities. This crate is also used outside of the Coreutils.
3535
- [`tests/by-util`](./tests/by-util/): The tests for all utilities.
3636
- [`src/bin/coreutils.rs`](./src/bin/coreutils.rs): Code for the multicall
3737
binary.
3838
- [`docs`](./docs/src): the documentation for the website
39+
- [`tests/uutests/`](./tests/uutests/): Crate implementing
40+
the various functions to test uutils commands.
3941

4042
Each utility is defined as a separate crate. The structure of each of these
4143
crates is as follows:
@@ -62,6 +64,8 @@ We have the following goals with our development:
6264
- **Reliable**: The utilities should never unexpectedly fail.
6365
- **Performant**: Our utilities should be written in fast idiomatic Rust. We aim
6466
to match or exceed the performance of the GNU utilities.
67+
[hyperfine](https://github.com/sharkdp/hyperfine) is the recommended tool for
68+
this task.
6569
- **Well-tested**: We should have a lot of tests to be able to guarantee
6670
reliability and compatibility.
6771

0 commit comments

Comments
 (0)