containers / containers/fuse-overlayfs
Wrong grammar for mapping options in man page
- Dominant language
- Rust
- Stars
- 691
- Forks
- 109
- Avg merge
- 5d 7h
- Merged PRs (30d)
- 2
Description
The [man page](https://github.com/containers/fuse-overlayfs/blob/main/fuse-overlayfs.1.md#options) describes the syntax for UID mappings as `UID:MAPPED-UID:LEN[,UID2:MAPPED-UID2:LEN2]`, i.e., with `,` as mapping separator. However, the examples section makes it look like `:` needs to be used instead, and AFAIU the code `,` is wrong and `:` is correct. The same is true for the GID mapping.
Contributor guide
No contributing guide indexed for this repository
Research direction
Open fuse-overlayfs.1.md at the Options section and compare the mapping syntax with the examples for both UID and GID mappings. Check the implementation's option parser to confirm the accepted separator, then update the man-page wording and examples so they agree; done means both mappings are documented consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 78/100