Skip to content

Add example to manpage#7841

Merged
sylvestre merged 38 commits intouutils:mainfrom
Its-Just-Nans:manpage-tldr
Nov 7, 2025
Merged

Add example to manpage#7841
sylvestre merged 38 commits intouutils:mainfrom
Its-Just-Nans:manpage-tldr

Conversation

@Its-Just-Nans
Copy link
Contributor

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

This PR do

Details

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 arguments in coreutils ?
  • Why not moving/creating a function to uucore to explore 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

EDIT - personnal notes

Old MR at https://github.com/uutils/coreutils/compare/main...Its-Just-Nans:coreutils:manpage-tldr-before-update?expand=1
Old branch at https://github.com/Its-Just-Nans/coreutils/tree/manpage-tldr-before-update

@sylvestre
Copy link
Contributor

sylvestre commented Apr 25, 2025

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

@github-actions
Copy link

github-actions bot commented Apr 25, 2025

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 AI reviewed Apr 25, 2025
View reviewed changes
Copy link

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
Copy link

github-actions bot commented Apr 26, 2025

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)

@sylvestre
Copy link
Contributor

sylvestre commented May 3, 2025

you still have a few jobs failing

@github-actions
Copy link

github-actions bot commented May 7, 2025

GNU testsuite comparison:

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

@Its-Just-Nans
Copy link
Contributor Author

Its-Just-Nans commented May 7, 2025 •
edited
Loading

you still have a few jobs failing

Not anymore ;)

image

coreutils is now a (default) feature

See rust-lang/cargo#1982

@Its-Just-Nans Its-Just-Nans mentioned this pull request May 8, 2025
Closed
@sylvestre
Copy link
Contributor

sylvestre commented Oct 22, 2025

@Its-Just-Nans sorry for the latency. now that we have uudoc, it might be easier!
would you to give it a try ? :)
thanks

@codspeed-hq
Copy link

codspeed-hq bot commented Oct 22, 2025 •
edited
Loading

CodSpeed Performance Report

Merging #7841 will not alter performance

Comparing Its-Just-Nans:manpage-tldr (453e6a3) with main (0058316)

Summary

✅ 125 untouched

@github-actions
Copy link

github-actions bot commented Oct 23, 2025

GNU testsuite comparison:

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

@Its-Just-Nans
Copy link
Contributor Author

Its-Just-Nans commented Oct 23, 2025

Done

cargo run --bin uudoc --features uudoc -- manpage more > more.1
man ./more.1

sylvestre
sylvestre reviewed Oct 23, 2025
View reviewed changes
@github-actions
Copy link

github-actions bot commented Oct 23, 2025

GNU testsuite comparison:

Skip an intermittent issue tests/tail/overlay-headers (fails in this run but passes in the 'main' branch)
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)

@Its-Just-Nans
Copy link
Contributor Author

Its-Just-Nans commented Nov 7, 2025 •
edited
Loading

Any update on this one @sylvestre ?

@github-actions
Copy link

github-actions bot commented Nov 7, 2025

GNU testsuite comparison:

Skip an intermittent issue tests/tail/overlay-headers (fails in this run but passes in the 'main' branch)

@github-actions
Copy link

github-actions bot commented Nov 7, 2025

GNU testsuite comparison:

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

@sylvestre sylvestre merged commit 477b37a into uutils:main Nov 7, 2025
122 checks passed
asder8215 pushed a commit to asder8215/coreutils that referenced this pull request Nov 8, 2025
@Its-Just-Nans @asder8215
Add example to manpage (uutils#7841)
ca33d3d
naoNao89 pushed a commit to naoNao89/coreutils that referenced this pull request Nov 8, 2025
@Its-Just-Nans @naoNao89
Add example to manpage (uutils#7841)
1c361e1
naoNao89 pushed a commit to naoNao89/coreutils that referenced this pull request Nov 9, 2025
@Its-Just-Nans @naoNao89
Add example to manpage (uutils#7841)
aa4bf72
@BrewTestBot BrewTestBot mentioned this pull request Nov 10, 2025
Merged
@moonfruit moonfruit mentioned this pull request Nov 10, 2025
Closed
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

@sylvestre sylvestre Awaiting requested review from sylvestre

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