Skip to content

cut: improve and shorten help text - #13985

Open
cakebaker wants to merge 2 commits into
uutils:mainfrom
cakebaker:cut_improve_help
Open

cut: improve and shorten help text#13985
cakebaker wants to merge 2 commits into
uutils:mainfrom
cakebaker:cut_improve_help

Conversation

@cakebaker

Copy link
Copy Markdown
Contributor

The current help output is very long and wordy. This PR is an attempt to make it much shorter.

I used the help of an AI for this PR.

@mustafaelrasheid

Copy link
Copy Markdown

I see no changes done to the french locale, even though both English and French help texts are about equally long.

@mustafaelrasheid

Copy link
Copy Markdown

Also, a lot of the length in the cut after-help output comes from new lines, which is rather an a lot easier corner to cut when it comes to length than shortening potentially valuable content.

@cakebaker

Copy link
Copy Markdown
Contributor Author

Changes since last push:

  • rebased
  • removed failing test test_help_uses_plain_text_headings. I removed it as I think it is not that useful to check whether the formatting of text headings are correct

@codspeed-hq

codspeed-hq Bot commented Aug 18, 2026

Copy link
Copy Markdown

Merging this PR will improve performance by 3.94%

⚠️ Different runtime environments detected

Some benchmarks with significant performance changes were compared across different runtime environments,
which may affect the accuracy of the results.

Open the report in CodSpeed to investigate

⚡ 1 improved benchmark
✅ 40 untouched benchmarks
⏩ 366 skipped benchmarks1

Performance Changes

Mode Benchmark BASE HEAD Efficiency
Simulation du_summarize_balanced_tree[(5, 4, 10)] 16.4 ms 15.8 ms +3.94%

Tip

Curious why this is faster? Comment @codspeedbot explain why this is faster on this PR, or directly use the CodSpeed MCP with your agent.


Comparing cakebaker:cut_improve_help (d9ac3be) with main (bfd7c63)

Open in CodSpeed

Footnotes

  1. 366 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.

@mustafaelrasheid

Copy link
Copy Markdown

Isn't .stdout_does_not_contain("###"); meant to be there to prevent issues such as #13988 and #13978 from regressing?

@github-actions

Copy link
Copy Markdown

GNU testsuite comparison:

Skip an intermittent issue tests/cut/bounded-memory (fails in this run but passes in the 'main' branch)
Skipping an intermittent issue tests/tail/symlink (passes in this run but fails in the 'main' branch)
Note: The gnu test tests/tail/pipe-f is now being skipped but was previously passing.
Congrats! The gnu test tests/cp/link-heap is now passing!
Congrats! The gnu test tests/rm/many-dir-entries-vs-OOM is now passing!
Congrats! The gnu test tests/seq/seq-epipe is now passing!

@cakebaker

Copy link
Copy Markdown
Contributor Author

@mustafaelrasheid yes, that's the reason the test was added. However, I don't think it needs testing as it was not a bug in the code.

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.

2 participants