Skip to content

Conversation

@Its-Just-Nans
Copy link
Contributor

@Its-Just-Nans Its-Just-Nans commented Apr 25, 2025

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

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

@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
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

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

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

you still have a few jobs failing

Not anymore ;)

image

coreutils is now a (default) feature

See rust-lang/cargo#1982

@sylvestre
Copy link
Contributor

@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

CodSpeed Performance Report

Merging #7841 will not alter performance

Comparing Its-Just-Nans:manpage-tldr (3df5a7c) with main (909da50)

Summary

✅ 106 untouched
⏩ 73 skipped1

Footnotes

  1. 73 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

@github-actions
Copy link

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

Done

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

@github-actions
Copy link

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)

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

manpage should contain the example from tldr

2 participants