coreutils icon indicating copy to clipboard operation
coreutils copied to clipboard

uudoc: move manpage generation away from the binary

Open aaron-ang opened this issue 3 months ago • 3 comments

close #4464.

Also moved man page generation test cases to a new file: test_uudoc.rs

Is there a simpler command to generate the man page instead of cargo run --bin uudoc --features uudoc -- manpage <utility>?

aaron-ang avatar Aug 22 '25 22:08 aaron-ang

GNU testsuite comparison:

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

github-actions[bot] avatar Aug 22 '25 23:08 github-actions[bot]

GNU testsuite comparison:

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

github-actions[bot] avatar Sep 05 '25 03:09 github-actions[bot]

hi @tertsdiepraam @sylvestre, I think my implementation is close. I will need your help to review and improve this PR. Thanks!

aaron-ang avatar Sep 05 '25 03:09 aaron-ang

Would you resolve conflicts?

oech3 avatar Oct 05 '25 10:10 oech3

Would you resolve conflicts?

yes, I will work on it

aaron-ang avatar Oct 06 '25 17:10 aaron-ang

Thankyou.

Is there a simpler command to generate the man page instead of cargo run --bin uudoc --features uudoc -- manpage ?

I think README.md should guide to use uudoc binary directly. I think wrapping command by cargo might cause rebuild if we used different profile at building.

oech3 avatar Oct 06 '25 17:10 oech3

GNU testsuite comparison:

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

github-actions[bot] avatar Oct 13 '25 01:10 github-actions[bot]

Failing tests (with non useful message for me)

oech3 avatar Oct 13 '25 06:10 oech3

CodSpeed Performance Report

Merging #8513 will not alter performance

Comparing aaron-ang:migrate-manpage (2919027) with main (905629b)

Summary

✅ 106 untouched
⏩ 73 skipped[^skipped]

[^skipped]: 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.

codspeed-hq[bot] avatar Oct 13 '25 08:10 codspeed-hq[bot]

GNU testsuite comparison:

Skipping an intermittent issue tests/tail/overlay-headers (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)

github-actions[bot] avatar Oct 13 '25 09:10 github-actions[bot]

GNU testsuite comparison:

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

github-actions[bot] avatar Oct 13 '25 21:10 github-actions[bot]

GNU testsuite comparison:

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

github-actions[bot] avatar Oct 13 '25 22:10 github-actions[bot]

GNU testsuite comparison:

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

github-actions[bot] avatar Oct 15 '25 21:10 github-actions[bot]

GNU testsuite comparison:

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

github-actions[bot] avatar Oct 15 '25 21:10 github-actions[bot]

GNU testsuite comparison:

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

github-actions[bot] avatar Oct 15 '25 22:10 github-actions[bot]

looks great, some minor comments

sylvestre avatar Oct 16 '25 02:10 sylvestre

GNU testsuite comparison:

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

github-actions[bot] avatar Oct 18 '25 08:10 github-actions[bot]

GNU testsuite comparison:

Skipping an intermittent issue tests/tail/overlay-headers (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)

github-actions[bot] avatar Oct 18 '25 19:10 github-actions[bot]

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)

github-actions[bot] avatar Oct 19 '25 04:10 github-actions[bot]

GNU testsuite comparison:

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

github-actions[bot] avatar Oct 22 '25 08:10 github-actions[bot]

well done!

sylvestre avatar Oct 22 '25 09:10 sylvestre

@aaron-ang Q. When packager discards uudoc binary at release, Should packager use same release profile with coreutils too?

Is building uudoc with debug and coreutils with release improve build time? or slower because of missing caches?

oech3 avatar Oct 22 '25 09:10 oech3

@aaron-ang Q. When packager discards uudoc binary at release, Should packager use same release profile with coreutils too?

Is building uudoc with debug and coreutils with release improve build time? or slower because of missing caches?

I believe building with the same profile will be much faster since they can share compilation artifacts. Most of the compilation happens at coreutils, not uudoc. The marginal increase in build time of compiling uudoc should be small compared to discarding and building it in debug.

aaron-ang avatar Oct 22 '25 18:10 aaron-ang

Thankyou. I feel uudoc takes time at clean build, but understood that current form is optimal.

oech3 avatar Oct 22 '25 18:10 oech3