From 1c8bcab5d5d88a879cbb9d385f3ff121d41a9b8f Mon Sep 17 00:00:00 2001 From: Daniel Hofstetter Date: Mon, 17 Nov 2025 08:22:20 +0100 Subject: [PATCH 1/2] Bump markdownlint_cli2_action from v20 to v21 --- .github/workflows/CICD.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/CICD.yml b/.github/workflows/CICD.yml index 5cd9526e8..a1c88a316 100644 --- a/.github/workflows/CICD.yml +++ b/.github/workflows/CICD.yml @@ -149,7 +149,7 @@ jobs: shell: bash run: | RUSTDOCFLAGS="-Dwarnings" cargo doc ${{ steps.vars.outputs.CARGO_FEATURES_OPTION }} --no-deps --workspace --document-private-items - - uses: DavidAnson/markdownlint-cli2-action@v20 + - uses: DavidAnson/markdownlint-cli2-action@v21 with: fix: "true" globs: | From e82cc75433b958ae846595a0c5f0037c2b29efa8 Mon Sep 17 00:00:00 2001 From: Daniel Hofstetter Date: Mon, 17 Nov 2025 09:07:04 +0100 Subject: [PATCH 2/2] docs: fix warnings from markdownlint --- docs/src/platforms.md | 10 +++++----- src/uu/join/BENCHMARKING.md | 16 ++++++++-------- src/uu/wc/BENCHMARKING.md | 20 ++++++++++---------- 3 files changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/src/platforms.md b/docs/src/platforms.md index b84516e3f..12f08d709 100644 --- a/docs/src/platforms.md +++ b/docs/src/platforms.md @@ -1,6 +1,6 @@ # Platform support - + uutils aims to be as "universal" as possible, meaning that we try to support many platforms. However, it is infeasible for us to guarantee that every @@ -19,13 +19,13 @@ platform support, with different guarantees. We support two tiers of platforms: The platforms in tier 1 and the platforms that we test in CI are listed below. -| Operating system | Tested targets | -| ---------------- | -------------- | +| Operating system | Tested targets | +| ---------------- | ------------------------ | | **Linux** | `x86_64-unknown-linux-gnu`
`x86_64-unknown-linux-musl`
`arm-unknown-linux-gnueabihf`
`i686-unknown-linux-gnu`
`aarch64-unknown-linux-gnu` | -| **macOS** | `x86_64-apple-darwin` | +| **macOS** | `x86_64-apple-darwin` | | **Windows** | `i686-pc-windows-msvc`
`x86_64-pc-windows-gnu`
`x86_64-pc-windows-msvc` | | **FreeBSD** | `x86_64-unknown-freebsd` | -| **Android** | `i686-linux-android` | +| **Android** | `i686-linux-android` | The platforms in tier 2 are more vague, but include: diff --git a/src/uu/join/BENCHMARKING.md b/src/uu/join/BENCHMARKING.md index 988259aa7..1698a2ff8 100644 --- a/src/uu/join/BENCHMARKING.md +++ b/src/uu/join/BENCHMARKING.md @@ -7,14 +7,14 @@ The amount of time spent in which part of the code can vary depending on the files being joined and the flags used. A benchmark with `-j` and `-i` shows the following time: -| Function/Method | Fraction of Samples | Why? | -| ---------------- | ------------------- | ---- | -| `Line::new` | 27% | Linear search for field separators, plus some vector operations. | -| `read_until` | 22% | Mostly libc reading file contents, with a few vector operations to represent them. | -| `Input::compare` | 20% | ~2/3 making the keys lowercase, ~1/3 comparing them. | -| `print_fields` | 11% | Writing to and flushing the buffer. | -| Other | 20% | | -| libc | 25% | I/O and memory allocation. | +| Function/Method | Fraction of Samples | Why? | +| ---------------- | ------------------- | ---------------------------------------------------------------------------------- | +| `Line::new` | 27% | Linear search for field separators, plus some vector operations. | +| `read_until` | 22% | Mostly libc reading file contents, with a few vector operations to represent them. | +| `Input::compare` | 20% | ~2/3 making the keys lowercase, ~1/3 comparing them. | +| `print_fields` | 11% | Writing to and flushing the buffer. | +| Other | 20% | | +| libc | 25% | I/O and memory allocation. | More detailed profiles can be obtained via [flame graphs](https://github.com/flamegraph-rs/flamegraph): diff --git a/src/uu/wc/BENCHMARKING.md b/src/uu/wc/BENCHMARKING.md index 60f9139da..d65c17d3f 100644 --- a/src/uu/wc/BENCHMARKING.md +++ b/src/uu/wc/BENCHMARKING.md @@ -29,7 +29,7 @@ suitable, and that if a file is given as its input directly (as in ### Counting lines and UTF-8 characters If the flags set are a subset of `-clm` then the input doesn't have to be decoded. The -input is read in chunks and the `bytecount` crate is used to count the newlines (`-l` flag) +input is read in chunks and the `bytecount` crate is used to count the newlines (`-l` flag) and/or UTF-8 characters (`-m` flag). It's useful to vary the line length in the input. GNU wc seems particularly @@ -83,16 +83,16 @@ performance. For example, `hyperfine 'wc somefile' 'uuwc somefile'`. If you want to get fancy and exhaustive, generate a table: -| | moby64.txt | odyssey256.txt | 25Mshortlines | /usr/bin/docker | -|------------------------|--------------|------------------|-----------------|-------------------| -| `wc ` | 1.3965 | 1.6182 | 5.2967 | 2.2294 | -| `wc -c ` | 0.8134 | 1.2774 | 0.7732 | 0.9106 | +| | moby64.txt | odyssey256.txt | 25Mshortlines | /usr/bin/docker | +|-------------------------|--------------|------------------|-----------------|-------------------| +| `wc ` | 1.3965 | 1.6182 | 5.2967 | 2.2294 | +| `wc -c ` | 0.8134 | 1.2774 | 0.7732 | 0.9106 | | `uucat \| wc -c` | 2.7760 | 2.5565 | 2.3769 | 2.3982 | -| `wc -l ` | 1.1441 | 1.2854 | 2.9681 | 1.1493 | -| `wc -L ` | 2.1087 | 1.2551 | 5.4577 | 2.1490 | -| `wc -m ` | 2.7272 | 2.1704 | 7.3371 | 3.4347 | -| `wc -w ` | 1.9007 | 1.5206 | 4.7851 | 2.8529 | -| `wc -lwcmL ` | 1.1687 | 0.9169 | 4.4092 | 2.0663 | +| `wc -l ` | 1.1441 | 1.2854 | 2.9681 | 1.1493 | +| `wc -L ` | 2.1087 | 1.2551 | 5.4577 | 2.1490 | +| `wc -m ` | 2.7272 | 2.1704 | 7.3371 | 3.4347 | +| `wc -w ` | 1.9007 | 1.5206 | 4.7851 | 2.8529 | +| `wc -lwcmL ` | 1.1687 | 0.9169 | 4.4092 | 2.0663 | Beware that: