Skip to content

uudoc: move manpage and completions generation out of binary#8513

Merged
sylvestre merged 1 commit into
uutils:mainfrom
aaron-ang:migrate-manpage
Oct 22, 2025
Merged

uudoc: move manpage and completions generation out of binary#8513
sylvestre merged 1 commit into
uutils:mainfrom
aaron-ang:migrate-manpage

Conversation

@aaron-ang
Copy link
Copy Markdown
Contributor

@aaron-ang aaron-ang commented Aug 22, 2025 •
edited
Loading

close #4464.

Manpage and completions generation now live in the uudoc binary.
Also moved man page generation test cases to a new file: test_uudoc.rs

cargo install --bin uudoc --features uudoc --path .
uudoc manpage <utility>

@aaron-ang aaron-ang force-pushed the migrate-manpage branch 6 times, most recently from d8d6a98 to a0ea101 Compare August 22, 2025 23:15
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Aug 22, 2025

GNU testsuite comparison:

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

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Sep 5, 2025

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)

@aaron-ang aaron-ang marked this pull request as ready for review September 5, 2025 03:55
@aaron-ang
Copy link
Copy Markdown
Contributor Author

aaron-ang commented Sep 5, 2025

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

@oech3

This comment was marked as resolved.

Sign in to view
@aaron-ang
Copy link
Copy Markdown
Contributor Author

aaron-ang commented Oct 6, 2025

Would you resolve conflicts?

yes, I will work on it

@oech3
Copy link
Copy Markdown
Contributor

oech3 commented Oct 6, 2025

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.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Oct 13, 2025

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)

@oech3

This comment was marked as resolved.

Sign in to view
@aaron-ang aaron-ang force-pushed the migrate-manpage branch 2 times, most recently from 4d01e19 to b4a9c2c Compare October 13, 2025 08:41
@codspeed-hq
Copy link
Copy Markdown

codspeed-hq Bot commented Oct 13, 2025 •
edited
Loading

CodSpeed Performance Report

Merging #8513 will not alter performance

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

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

@aaron-ang aaron-ang changed the title uudoc: move manpage generation away from the binary uudoc: move manpage and completions generation away from the binary Oct 13, 2025
@aaron-ang aaron-ang changed the title uudoc: move manpage and completions generation away from the binary uudoc: move manpage and completions generation away from binary Oct 13, 2025
@aaron-ang aaron-ang changed the title uudoc: move manpage and completions generation away from binary uudoc: move manpage and completions generation from binary Oct 13, 2025
@aaron-ang aaron-ang changed the title uudoc: move manpage and completions generation from binary uudoc: move manpage and completions generation out of binary Oct 13, 2025
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Oct 13, 2025

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)

@aaron-ang aaron-ang force-pushed the migrate-manpage branch 4 times, most recently from ce81973 to 250a799 Compare October 13, 2025 21:08
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Oct 13, 2025

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

github-actions Bot commented Oct 15, 2025

GNU testsuite comparison:

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

@aaron-ang aaron-ang mentioned this pull request Oct 15, 2025
Open
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Oct 15, 2025

GNU testsuite comparison:

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

sylvestre
sylvestre reviewed Oct 16, 2025
View reviewed changes
Comment thread fuzz/uufuzz/Cargo.toml Outdated
sylvestre
sylvestre reviewed Oct 16, 2025
View reviewed changes
Comment thread GNUmakefile
sylvestre
sylvestre reviewed Oct 16, 2025
View reviewed changes
Comment thread src/common/validation.rs
@sylvestre
Copy link
Copy Markdown
Contributor

sylvestre commented Oct 16, 2025

looks great, some minor comments

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Oct 18, 2025

GNU testsuite comparison:

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

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Oct 18, 2025

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)

@aaron-ang aaron-ang force-pushed the migrate-manpage branch 2 times, most recently from 9c9f907 to f2170e3 Compare October 19, 2025 04:25
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Oct 19, 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)

@aaron-ang aaron-ang requested a review from sylvestre October 22, 2025 08:17
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Oct 22, 2025

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)

@sylvestre
Copy link
Copy Markdown
Contributor

sylvestre commented Oct 22, 2025

well done!

@sylvestre sylvestre merged commit 94e1023 into uutils:main Oct 22, 2025
122 checks passed
@oech3
Copy link
Copy Markdown
Contributor

oech3 commented Oct 22, 2025

@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 oech3 mentioned this pull request Oct 22, 2025
Closed
@aaron-ang
Copy link
Copy Markdown
Contributor Author

aaron-ang commented Oct 22, 2025 •
edited
Loading

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

@oech3
Copy link
Copy Markdown
Contributor

oech3 commented Oct 22, 2025 via email

@BrewTestBot BrewTestBot mentioned this pull request Oct 24, 2025
Merged
@moonfruit moonfruit mentioned this pull request Oct 27, 2025
Closed
@shayelkin shayelkin mentioned this pull request Nov 5, 2025
Merged
12 tasks
reneeotten pushed a commit to macports/macports-ports that referenced this pull request Nov 8, 2025
@shayelkin @reneeotten
coreutils-uutils: update to v0.3.0
0d7c5fc 
* update release to version 0.3.0.
* manpage and completions commands were moved from coreutils to uudoc
  (in uutils/coreutils#8513), update the
  Portfile to build and use uudoc to generate those.
trustbyte pushed a commit to trustbyte/macports-ports that referenced this pull request Nov 10, 2025
@shayelkin @trustbyte
coreutils-uutils: update to v0.3.0
1e9ea54 
* update release to version 0.3.0.
* manpage and completions commands were moved from coreutils to uudoc
  (in uutils/coreutils#8513), update the
  Portfile to build and use uudoc to generate those.
JGoldstone pushed a commit to JGoldstone/macports-ports that referenced this pull request Nov 24, 2025
@shayelkin @JGoldstone
coreutils-uutils: update to v0.3.0
64a1a27 
* update release to version 0.3.0.
* manpage and completions commands were moved from coreutils to uudoc
  (in uutils/coreutils#8513), update the
  Portfile to build and use uudoc to generate those.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

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

Move the manpage generation away from the binary

3 participants

@aaron-ang @oech3 @sylvestre