Skip to content

Add example to manpage #7841

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Add example to manpage #7841

wants to merge 5 commits into from

Conversation

Its-Just-Nans
Copy link
Contributor

@Its-Just-Nans Its-Just-Nans commented Apr 25, 2025 •
edited
Loading

This PR do

image

coreutils 0.0.30 (multi-call binary)

Usage: coreutils [function [arguments...]]
       coreutils --list

Functions:
      completion
           Usage: completion <utility> <shell>
      'manpage'
           Usage: manpage <utility>
      '<uutils>' [arguments...]

Options:
      --list    lists all defined functions, one per row

Currently defined functions:

    [, b2sum, b3sum, base32, base64, basename, basenc, cat, cksum, comm, cp, csplit, cut, date,
    dd, df, dir, dircolors, dirname, du, echo, env, expand, expr, factor, false, fmt, fold,
    hashsum, head, join, link, ln, ls, md5sum, mkdir, mktemp, more, mv, nl, numfmt, od, paste,
    pr, printenv, printf, ptx, pwd, readlink, realpath, rm, rmdir, seq, sha1sum, sha224sum,
    sha256sum, sha3-224sum, sha3-256sum, sha3-384sum, sha3-512sum, sha384sum, sha3sum,
    sha512sum, shake128sum, shake256sum, shred, shuf, sleep, sort, split, sum, tac, tail, tee,
    test, touch, tr, true, truncate, tsort, unexpand, uniq, unlink, vdir, wc, yes

Questions

  • Why not using clap for argments in coreutils ?
  • Why not moving creating a function to uucore to explore a the tldrzip file (both coreutils and uudoc use zip)
    • to do that, the zip crate need to be added to uucore - not sure about the idea

@sylvestre
Copy link
Contributor

could you please replace the screenshot by text? it is terrible for search and accessibility
thanks

@github-actions GitHub Actions
Copy link

GNU testsuite comparison:

Skipping an intermittent issue tests/misc/tee (passes in this run but fails in the 'main' branch)

@sylvestre sylvestre requested a review from Copilot April 25, 2025 21:44
Copilot
Copilot AI reviewed Apr 25, 2025
View reviewed changes
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR addresses issue #5094 by cleaning up the help message for the coreutils binary and adding an example to the manpage. The changes include:

  • Adding the "dep:zip" dependency to the default feature in Cargo.toml.
  • Updating the uudoc feature to use "dep:zip" for consistency.
  • Adding a "required-features" constraint for the coreutils binary.
Comments suppressed due to low confidence (1)

Cargo.toml:545

  • Consider adding tests to verify that the coreutils binary build fails when the default feature is disabled, ensuring the required-features constraint works as expected.
required-features = ["default"]

@github-actions GitHub Actions
Copy link

GNU testsuite comparison:

Skipping an intermittent issue tests/misc/tee (passes in this run but fails in the 'main' branch)
Skipping an intermittent issue tests/timeout/timeout (passes in this run but fails in the 'main' branch)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot code review Copilot Copilot left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

manpage should contain the example from tldr
2 participants
@Its-Just-Nans @sylvestre