Man page for ln has mismatch between Synopsis and Extra sections
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 24.1k
- Forks
- 2k
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 365
Description
The EXTRA section in the man page for ln starts:
In the 1st form, create a link to TARGET with the name LINK_NAME. In the 2nd form, create a link to TARGET in the current directory. In the 3rd and 4th forms, create links....
However, the SYNOPSIS section only shows one form:
ln [--backup] [-b ] [-f|--force] [-i|--interactive] [-n|--no-dereference] [-L|--logical] [-P|--physical] [-s|--symbolic] [-S|--suffix] [-t|--target-directory]
[-T|--no-target-directory] [-r|--relative] [-v|--verbose] [-h|--help] [-V|--version] <files>
It looks like the EXTRA text is a holdover from the DESCRIPTION section of the old man page:
https://www.gnu.org/software/coreutils/manual/html_node/ln-invocation.html
The uutils man page should be updated to either show the 4 forms in the SYNOPSIS or update the EXTRA section accordingly.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the uutils man page for ln and compare its SYNOPSIS and EXTRA sections with the linked GNU Coreutils reference. Update the documentation so the listed forms agree, then verify that the rendered man page no longer describes forms absent from the SYNOPSIS.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100