uudoc: write manpages and completions to a directory by limadog9 · Pull Request #15402 · uutils/coreutils

limadog9 · 2026-10-16T02:17:33Z

Add –out-dir for manpages and shell completions, with regression tests and updated examples.

oech3 · 2026-10-16T02:30:33Z

Thanks. But I prefer generating all completions for all shells with uudoc completion --out-dir /usr/share.

limadog9 · 2026-10-16T03:01:02Z

Thanks @oech3! Addressed the feedback and pushed the updates.

This is why elevators should run on Rust. Rust catches the problems before the elevator moves. Python waits until you’re halfway between floors to let you know something went wrong. 🦀

Sign in to view

      run: |
-        mkdir -p share/{man/man1,bash-completion/completions,fish/vendor_completions.d,zsh/site-functions,elvish/lib}
        _uudoc=target/${{ matrix.job.target }}/release/uudoc
        for bin in $('target/${{ matrix.job.target }}/release/coreutils' --list) coreutils;do


Sign in to view

      run: |
-        mkdir -p share/{man/man1,bash-completion/completions,fish/vendor_completions.d,zsh/site-functions,elvish/lib}
        _uudoc=target/${{ matrix.job.target }}/release/uudoc
        for bin in $('target/${{ matrix.job.target }}/release/coreutils' --list) coreutils;do


Sign in to view

-          ${_uudoc} completion ${bin} fish > share/fish/vendor_completions.d/${bin}.fish
-          ${_uudoc} completion ${bin} zsh > share/zsh/site-functions/_${bin}
-          ${_uudoc} completion ${bin} elvish > share/elvish/lib/${bin}.elv
+          "${_uudoc}" manpage "${bin}" --out-dir share/man/man1


Sign in to view

 build-uudoc:
 	@unset CARGO_BUILD_TARGET && ${CARGO} build ${CARGOFLAGS} --bin uudoc --features "uudoc ${EXES}" ${PROFILE_CMD} --no-default-features

+ifeq ($(MANPAGES),y)


limadog9 · 2026-10-16T03:22:26Z

Thanks @oech3 — addressed all four points. uudoc generate --out-dir DIR now generates all manpages and shell completions together. CI uses that single command without the loop or ${bin} argument, and Make now uses UUDOC and install-docs. Updated the related workflows and README too.

All 36 local tests and installation/packaging checks pass. Squashed into one commit and pushed

Sign in to view

+    println!("  manpage [utility] [--out-dir DIR]            Generate manpages");
+    println!("  completion [utility] [shell] [--out-dir DIR] Generate shell completions");


limadog9 · 2026-10-16T03:42:22Z

Thanks @oech3 — renamed the command to manpages-and-completions and removed stdout output. All manpage/completion commands now require --out-dir. Updated the docs, tests, and build scripts, then squashed and pushed. All 35 local tests and installation/packaging checks pass.

Sign in to view

+    println!("  manpage [utility] --out-dir DIR                        Generate manpages");
+    println!("  completion [utility] [shell] --out-dir DIR             Generate shell completions");


limadog9 · 2026-10-16T04:11:40Z

Thanks @oech3 — removed the separate manpage and completion commands and their parsers. Everything now uses manpages-and-completions. Updated the docs and tests, squashed, and pushed. All 30 local tests and installation/packaging checks pass.

Sign in to view

+    );
+    println!(
+        "  manpages-and-completions --out-dir DIR [utility]...    Generate manpages and shell completions"
+    );


Sign in to view

+            Shell::Fish => "fish/vendor_completions.d",
+            Shell::PowerShell => "powershell",
+            Shell::Zsh => "zsh/site-functions",
+            _ => return Err(io::Error::other(format!("unsupported shell: {shell}"))),


limadog9 · 2026-10-16T05:23:49Z

Thanks @oech3 — restored the original help-text spacing and changed the shell fallback to unreachable!(). Squashed and pushed.

oech3 · 2026-10-16T08:12:54Z

Perhaps, It might better to accept uudoc subcommands --usr /usr e.g. uudoc manpages md completions symlink-coreutils locales --usr /usr. (last 2 subcommands are just examples for the future, this PR does not need to support).

Then /usr/share/docs/coreutils/ls.md is installed...?

oech3 · 2026-10-16T13:42:45Z

-    println!("  completion <utility> <shell>   Generate shell completions for a utility");
+    println!("  manpages md completions --usr DIR    Generate the selected documentation formats");
+    println!("  Use --out-dir DIR to override the shared-data directory.");
+    println!("  Use --utilities NAME... to select utilities (default: all compiled utilities).");


I don't think we need to select some utils only.

Also reply to each thread instead.

oech3 · 2026-10-16T14:21:12Z

Drop --out-dir as --usr is enough. Generally, we should keep options minimal for easier maintainance.

limadog9 · 2026-10-16T15:03:21Z

Removed --out-dir; --usr is now the only destination option. Updated Make, README, and tests. Make stages the generated files to preserve custom installation paths.

This comment was marked as resolved.

Sign in to view

limadog9 force-pushed the fix/uudoc-output-directory branch from 602dc98 to ed1a68b Compare October 16, 2026 02:58