erofs-freebsd-out-tree/tests/TC111-manpage-accuracy.md

Test Case: Manual Page Accuracy

Test ID: TC111-manpage-accuracy
Category: Documentation
Priority: Low
Regression: None

Objective

Verify that manual pages accurately document all mount options, supported features, and behavior.

Preconditions

• The repository docs/erofs.5 source and README.md are available.
• Access to the current module source for cross-reference.
• A FreeBSD 15 guest with the current erofs.ko and a valid image.
• Do not assume that a filesystem-specific mount_erofs(8) exists.

Test Steps

1. Confirm whether /sbin/mount_erofs exists. If it does not, verify the documented generic /sbin/mount -t erofs path directly.
2. Mount without -o ro, with -o rw, and with documented standard flags; record the resulting mount flags and write behavior.
3. Verify every documented filesystem-specific option against src/super.c and an applicable real image.
4. Submit an unknown filesystem-specific option and require nmount(2) to reject it with EINVAL without leaving a mount.
5. Cross-reference README.md, docs/features.md, docs/architecture.md, docs/erofs.5, and tests/TEST-COVERAGE-MATRIX.md with current source and qualified manual results.
6. Validate all examples and SEE ALSO references that apply to the qualified FreeBSD environment.

Expected Results

• The documented generic mount path works without mount_erofs(8).
• Every successful EROFS mount is read-only, including a request containing -o rw; mutating operations return EROFS.
• Documented filesystem-specific options match the current parser and work on their applicable fixture types.
• Unknown filesystem-specific options return EINVAL and create no mount.
• Feature claims match the implementation and qualified coverage.
• Examples and SEE ALSO entries are accurate.

Verification Method

• Record direct command exit status separately from tracing-tool status.
• Verify feature claims against TEST-COVERAGE-MATRIX.md.
• Check documentation against source and actual /sbin/mount/nmount(2) behavior.
• Validate all code examples on their applicable fixture type.

Cleanup

Unmount the test filesystem, detach its md provider, and unload the exact test module. Assert that no EROFS mount, md provider, or EROFS KLD remains.

Notes

Tests feature 61: manual pages accuracy and completeness.