Skip to content

docs: fix inaccuracies in README#139

Merged
zvonkok merged 1 commit intoNVIDIA:mainfrom
YardenCuriel:docs/fix-readme-inaccuracies
Feb 24, 2026
Merged

docs: fix inaccuracies in README#139
zvonkok merged 1 commit intoNVIDIA:mainfrom
YardenCuriel:docs/fix-readme-inaccuracies

Conversation

@YardenCuriel
Copy link

Cross-referenced the README against the source and found three inaccuracies:

Architecture diagram mount points
The diagram listed /dev/shm but mount.rs::setup_at() actually mounts /run (tmpfs) and /tmp (tmpfs). No /dev/shm mount exists in the codebase.

Dependency count
Security model section stated 9 direct dependencies but Cargo.toml lists 7: nix, cfg-if, log, kernlog, rlimit, libc, once_cell.

Non-existent fuzz target
Testing section referenced cargo +nightly fuzz run mount_parsing but only kernel_params exists in fuzz/fuzz_targets/ and fuzz/Cargo.toml.

- Architecture diagram listed /dev/shm but code mounts /run and /tmp
  - Dependency count was 9 but Cargo.toml has 7 direct dependencies
  - Removed reference to mount_parsing fuzz target that doesn't exist

Signed-off-by: yardencuriel <splint_disk.8i@icloud.com>
@zvonkok zvonkok added the ok-to-test Ok to test label Feb 24, 2026
Copy link
Collaborator

@zvonkok zvonkok left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @YardenCuriel

@zvonkok zvonkok merged commit 9d66ea2 into NVIDIA:main Feb 24, 2026
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ok-to-test Ok to test

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants