Skip to content

Commit e4fe9f4

Browse files
committed
docs: generalize skip flag references and fix fuse_probe doc
- Use generic pdu_test_skip_* wording in AI instructions instead of naming the specific cross_device flag - Mention that panic messages include the specific skip flag - Fix fuse_probe doc: say "exists" not "is accessible" for /dev/fuse, say "tool names" not "tool paths" for the return value - Regenerate AI instruction files https://claude.ai/code/session_01LfpnUZrgq93MVZgA3KVqE6
1 parent 1a9b4b6 commit e4fe9f4

6 files changed

Lines changed: 7 additions & 7 deletions

File tree

.github/copilot-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ Read and follow the CONTRIBUTING.md file in this repository for all code style c
1919
- Run `FMT=true LINT=true BUILD=true TEST=true DOC=true ./test.sh` to validate changes. If a test fails with a hint about `RUSTFLAGS` and `--cfg pdu_test_skip_*`, follow the hint and rerun with the suggested flags.
2020
- **ALWAYS run the full test suite** (`FMT=true LINT=true BUILD=true TEST=true DOC=true ./test.sh`) before committing, regardless of how trivial the change seems — this includes documentation-only changes, comment edits, config changes, and refactors. The test suite checks formatting, linting, building, tests, and docs across multiple feature combinations; any type of change can break any of these checks.
2121
- Set `PDU_NO_FAIL_FAST=true` to run all checks instead of stopping at the first failure — this lets you see which checks pass and which fail
22-
- Some integration tests require external (non-Cargo) dependencies: `squashfs-tools`, `squashfuse`, `fuse3` (see CONTRIBUTING.md for details). If unavailable, skip with `RUSTFLAGS='--cfg pdu_test_skip_cross_device'`
22+
- Some integration tests require external (non-Cargo) dependencies (see CONTRIBUTING.md for details). If unavailable, the tests will panic with a hint showing the `RUSTFLAGS='--cfg pdu_test_skip_*'` flag to skip them

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ Read and follow the CONTRIBUTING.md file in this repository for all code style c
1919
- Run `FMT=true LINT=true BUILD=true TEST=true DOC=true ./test.sh` to validate changes. If a test fails with a hint about `RUSTFLAGS` and `--cfg pdu_test_skip_*`, follow the hint and rerun with the suggested flags.
2020
- **ALWAYS run the full test suite** (`FMT=true LINT=true BUILD=true TEST=true DOC=true ./test.sh`) before committing, regardless of how trivial the change seems — this includes documentation-only changes, comment edits, config changes, and refactors. The test suite checks formatting, linting, building, tests, and docs across multiple feature combinations; any type of change can break any of these checks.
2121
- Set `PDU_NO_FAIL_FAST=true` to run all checks instead of stopping at the first failure — this lets you see which checks pass and which fail
22-
- Some integration tests require external (non-Cargo) dependencies: `squashfs-tools`, `squashfuse`, `fuse3` (see CONTRIBUTING.md for details). If unavailable, skip with `RUSTFLAGS='--cfg pdu_test_skip_cross_device'`
22+
- Some integration tests require external (non-Cargo) dependencies (see CONTRIBUTING.md for details). If unavailable, the tests will panic with a hint showing the `RUSTFLAGS='--cfg pdu_test_skip_*'` flag to skip them

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,5 @@ Read and follow the CONTRIBUTING.md file in this repository for all code style c
1919
- Run `FMT=true LINT=true BUILD=true TEST=true DOC=true ./test.sh` to validate changes. If a test fails with a hint about `RUSTFLAGS` and `--cfg pdu_test_skip_*`, follow the hint and rerun with the suggested flags.
2020
- **ALWAYS run the full test suite** (`FMT=true LINT=true BUILD=true TEST=true DOC=true ./test.sh`) before committing, regardless of how trivial the change seems — this includes documentation-only changes, comment edits, config changes, and refactors. The test suite checks formatting, linting, building, tests, and docs across multiple feature combinations; any type of change can break any of these checks.
2121
- Set `PDU_NO_FAIL_FAST=true` to run all checks instead of stopping at the first failure — this lets you see which checks pass and which fail
22-
- Some integration tests require external (non-Cargo) dependencies: `squashfs-tools`, `squashfuse`, `fuse3` (see CONTRIBUTING.md for details). If unavailable, skip with `RUSTFLAGS='--cfg pdu_test_skip_cross_device'`
22+
- Some integration tests require external (non-Cargo) dependencies (see CONTRIBUTING.md for details). If unavailable, the tests will panic with a hint showing the `RUSTFLAGS='--cfg pdu_test_skip_*'` flag to skip them
2323
- `gh` (GitHub CLI) is not installed — do not attempt to use it

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -377,7 +377,7 @@ On Debian/Ubuntu:
377377
sudo apt install squashfs-tools squashfuse fuse3
378378
```
379379

380-
Tests that need these tools will panic with a diagnostic message if they are missing. To skip them instead, set:
380+
Tests that need these tools will panic with a diagnostic message if they are missing. The panic message includes the specific `RUSTFLAGS='--cfg pdu_test_skip_*'` flag to skip the test. For example:
381381

382382
```sh
383383
export RUSTFLAGS='--cfg pdu_test_skip_cross_device'

template/ai-instructions/shared.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ Read and follow the CONTRIBUTING.md file in this repository for all code style c
1919
- Run `FMT=true LINT=true BUILD=true TEST=true DOC=true ./test.sh` to validate changes. If a test fails with a hint about `RUSTFLAGS` and `--cfg pdu_test_skip_*`, follow the hint and rerun with the suggested flags.
2020
- **ALWAYS run the full test suite** (`FMT=true LINT=true BUILD=true TEST=true DOC=true ./test.sh`) before committing, regardless of how trivial the change seems — this includes documentation-only changes, comment edits, config changes, and refactors. The test suite checks formatting, linting, building, tests, and docs across multiple feature combinations; any type of change can break any of these checks.
2121
- Set `PDU_NO_FAIL_FAST=true` to run all checks instead of stopping at the first failure — this lets you see which checks pass and which fail
22-
- Some integration tests require external (non-Cargo) dependencies: `squashfs-tools`, `squashfuse`, `fuse3` (see CONTRIBUTING.md for details). If unavailable, skip with `RUSTFLAGS='--cfg pdu_test_skip_cross_device'`
22+
- Some integration tests require external (non-Cargo) dependencies (see CONTRIBUTING.md for details). If unavailable, the tests will panic with a hint showing the `RUSTFLAGS='--cfg pdu_test_skip_*'` flag to skip them

tests/one_file_system.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,10 @@ struct FuseTools {
8686
/// Verifies:
8787
/// 1. `mksquashfs` binary exists
8888
/// 2. `squashfuse` binary exists
89-
/// 3. `/dev/fuse` is accessible
89+
/// 3. `/dev/fuse` exists
9090
/// 4. `fusermount3` (or `fusermount`) binary exists
9191
///
92-
/// Returns `Ok(FuseTools)` with the discovered tool paths, or `Err` with a diagnostic message.
92+
/// Returns `Ok(FuseTools)` with the discovered tool names, or `Err` with a diagnostic message.
9393
fn fuse_probe() -> Result<FuseTools, String> {
9494
which("mksquashfs").map_err(|error| {
9595
format!("`mksquashfs` not found: {error}. Install squashfs-tools for your platform.")

0 commit comments

Comments
 (0)