uutils / uutils/coreutils

ln: manpage enumerates forms under EXTRA without examples

Open Beginner friendly
#11,564 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

U - ln
Dominant language
Rust
Stars
24.1k
Forks
2k
Avg merge
1d 5h
Merged PRs (30d)
365

Description

(Forwarded from LP Bug #2141478)

Problem

The ln manual page mentions different usage forms under the EXTRA section:

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 to each TARGET in DIRECTORY.

The GNU page exemplifies these forms in the SYNOPSIS:

       ln [OPTION]... [-T] TARGET LINK_NAME
       ln [OPTION]... TARGET
       ln [OPTION]... TARGET... DIRECTORY
       ln [OPTION]... -t DIRECTORY TARGET...

However the uutils page is missing any examples using TARGET, LINK_NAME, and DIRECTORY even though they are mentioned.

Contributor guide

Open the contributing guide

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.

Research direction

Start by locating the ln manual-page source and reviewing its EXTRA section alongside the GNU synopsis quoted in the issue. Add examples for the TARGET, LINK_NAME, and DIRECTORY forms, then verify that the rendered page explains each listed usage form.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.