Wrong grammar for mapping options in man page

Open Beginner friendly
#468 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
rust
Domain
documentation

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.

Description

The man page 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.

Dominant language
Rust
Stars
691
Forks
109
Avg merge
5d 7h
Merged PRs (30d)
2

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from containers/fuse-overlayfs

All issues in containers/fuse-overlayfs

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.