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

aaron-ang · 2025-08-22T22:23:20Z

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>

github-actions · 2025-08-22T23:35:38Z

GNU testsuite comparison:

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

github-actions · 2025-09-05T03:54:14Z

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 · 2025-09-05T03:56:09Z

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

aaron-ang · 2025-10-06T17:13:57Z

Would you resolve conflicts?

yes, I will work on it

oech3 · 2025-10-06T17:54:30Z

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 · 2025-10-13T01:03:37Z

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)

codspeed-hq · 2025-10-13T08:56:23Z

CodSpeed Performance Report

Merging #8513 will not alter performance

_{Comparing aaron-ang:migrate-manpage (f2170e3) with main (cd27f69)}

Summary

✅ 106 untouched
⏩ 73 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. ↩

github-actions · 2025-10-13T09:03:16Z

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 · 2025-10-13T21:31:28Z

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 · 2025-10-13T22:24:56Z

GNU testsuite comparison:

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

github-actions · 2025-10-15T21:02:43Z

GNU testsuite comparison:

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

github-actions · 2025-10-15T21:32:02Z

GNU testsuite comparison:

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

github-actions · 2025-10-15T22:02:06Z

GNU testsuite comparison:

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

sylvestre · 2025-10-16T02:20:40Z

fuzz/uufuzz/Cargo.toml

 [dependencies]
 console = "0.16.0"
 libc = "0.2.153"
+phf = "0.13.1"


i am not sure it is necessary

The fuzz test will fail if not included, iirc it was "the lock file needs to be updated but --locked was passed to prevent this"

oh I guess it works fine now, will rebase

sylvestre · 2025-10-16T02:21:49Z

GNUmakefile

 	unexpand \
 	uniq \
 	unlink \
+	uudoc \


i guess it means that make install will install it, no ?

This list is for test feature flags. The uudoc tests will not build unless #[cfg(feature = "uudoc")] is stated.

sylvestre · 2025-10-16T02:23:22Z

src/common/validation.rs

+        "[" => "test",
+
+        // hashsum aliases - all these hash commands are aliases for hashsum
+        "md5sum" | "sha1sum" | "sha224sum" | "sha256sum" | "sha384sum" | "sha512sum"


uucore is used by other programs, i am not sure we want this list in uucore

how about moving this file to src/common/validation.rs and creating a new file src/lib.rs to expose the module?

sylvestre · 2025-10-16T02:24:26Z

looks great, some minor comments

github-actions · 2025-10-18T08:52:07Z

GNU testsuite comparison:

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

github-actions · 2025-10-18T19:39:26Z

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 · 2025-10-19T04:45:06Z

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 force-pushed the migrate-manpage branch 6 times, most recently from d8d6a98 to a0ea101 Compare August 22, 2025 23:15

aaron-ang force-pushed the migrate-manpage branch from a0ea101 to e15b68a Compare September 5, 2025 03:33

aaron-ang marked this pull request as ready for review September 5, 2025 03:55

This comment was marked as resolved.

Sign in to view

aaron-ang force-pushed the migrate-manpage branch from e15b68a to 939cb4e Compare October 13, 2025 00:42

This comment was marked as resolved.

Sign in to view

aaron-ang force-pushed the migrate-manpage branch 2 times, most recently from 4d01e19 to b4a9c2c Compare October 13, 2025 08:41

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 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 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 changed the title ~~uudoc: move manpage and completions generation from binary~~ uudoc: move manpage and completions generation out of binary Oct 13, 2025

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

aaron-ang force-pushed the migrate-manpage branch from 250a799 to 18bc626 Compare October 13, 2025 22:02

aaron-ang force-pushed the migrate-manpage branch from f6b7f06 to 8dfa72e Compare October 15, 2025 20:41

sylvestre force-pushed the migrate-manpage branch from 8dfa72e to dea5ef6 Compare October 15, 2025 21:12

aaron-ang force-pushed the migrate-manpage branch from dea5ef6 to 2df6d44 Compare October 15, 2025 21:39

aaron-ang mentioned this pull request Oct 15, 2025

CI: fuzz: Run cargo fmt and cargo clippy #7718

Open

sylvestre reviewed Oct 16, 2025

View reviewed changes

aaron-ang force-pushed the migrate-manpage branch from c581471 to a89a1a0 Compare October 18, 2025 08:26

aaron-ang force-pushed the migrate-manpage branch from a2bff5d to 9c9f907 Compare October 19, 2025 04:22

uudoc: move manpage generation away from the binary

f2170e3

aaron-ang force-pushed the migrate-manpage branch from 9c9f907 to f2170e3 Compare October 19, 2025 04:25

Uh oh!

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

Are you sure you want to change the base?

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

Conversation

aaron-ang commented Aug 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Aug 22, 2025

Uh oh!

github-actions bot commented Sep 5, 2025

Uh oh!

aaron-ang commented Sep 5, 2025

Uh oh!

This comment was marked as resolved.

aaron-ang commented Oct 6, 2025

Uh oh!

oech3 commented Oct 6, 2025

Uh oh!

github-actions bot commented Oct 13, 2025

Uh oh!

This comment was marked as resolved.

codspeed-hq bot commented Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #8513 will not alter performance

Summary

Footnotes

Uh oh!

github-actions bot commented Oct 13, 2025

Uh oh!

github-actions bot commented Oct 13, 2025

Uh oh!

github-actions bot commented Oct 13, 2025

Uh oh!

github-actions bot commented Oct 15, 2025

Uh oh!

github-actions bot commented Oct 15, 2025

Uh oh!

github-actions bot commented Oct 15, 2025

Uh oh!

sylvestre Oct 16, 2025

Choose a reason for hiding this comment

Uh oh!

aaron-ang Oct 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aaron-ang Oct 19, 2025

Choose a reason for hiding this comment

Uh oh!

sylvestre Oct 16, 2025

Choose a reason for hiding this comment

Uh oh!

aaron-ang Oct 18, 2025

Choose a reason for hiding this comment

Uh oh!

sylvestre Oct 16, 2025

Choose a reason for hiding this comment

Uh oh!

aaron-ang Oct 18, 2025

Choose a reason for hiding this comment

Uh oh!

sylvestre commented Oct 16, 2025

Uh oh!

github-actions bot commented Oct 18, 2025

Uh oh!

github-actions bot commented Oct 18, 2025

Uh oh!

github-actions bot commented Oct 19, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

aaron-ang commented Aug 22, 2025 •

edited

Loading

codspeed-hq bot commented Oct 13, 2025 •

edited

Loading

aaron-ang Oct 18, 2025 •

edited

Loading