Skip to content

Commit af645de

Browse files
committed
docs(cli): mcpp pack --help still said tarball
It says what it produces, and since #448 that is a .zip for a Windows target. `--format tar` selects "an archive rather than a plain directory"; WHICH archive follows the artifact, because a .tar.gz full of DLLs is a package most Windows users cannot open without installing something first. Found by smoke-testing the RELEASED binary — the behaviour shipped and its help did not follow.
1 parent b012c4a commit af645de

1 file changed

Lines changed: 9 additions & 3 deletions

File tree

src/cli.cppm

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ void print_usage() {
6363
std::println(" mcpp update [pkg] Re-resolve deps and rewrite mcpp.lock");
6464
std::println(" mcpp search <keyword> Search packages in registries");
6565
std::println(" mcpp publish [--dry-run] Publish package to default registry");
66-
std::println(" mcpp pack [--mode <m>] Build + bundle a tarball (m: system|vendored|self-contained|static)");
66+
std::println(" mcpp pack [--mode <m>] Build + bundle an archive (m: system|vendored|self-contained|static)");
6767
std::println(" mcpp emit xpkg [-V VER] [-o FILE] Generate xpkg Lua entry");
6868
std::println(" mcpp xpkg parse <file.lua> [--json] Validate an xpkg descriptor (resolver grammar)");
6969
std::println("");
@@ -399,13 +399,19 @@ int run(int argc, char** argv) {
399399
.option(cl::Option("allow-dirty").help("Allow uncommitted changes"))
400400
.action(wrap_rc(cmd_publish)))
401401
.subcommand(cl::App("pack")
402-
.description("Build + bundle into a self-contained tarball")
402+
// "archive", not "tarball": a Windows target produces a .zip, and
403+
// the help said tarball while the code had already stopped
404+
// agreeing. `--format tar` likewise selects "an archive rather
405+
// than a plain directory" — WHICH archive follows the artifact,
406+
// because a .tar.gz full of DLLs is a package most Windows users
407+
// cannot open without installing something first.
408+
.description("Build + bundle into a self-contained archive")
403409
.option(cl::Option("mode").takes_value()
404410
.help("system | vendored (default) | self-contained | static"))
405411
.option(cl::Option("target").takes_value()
406412
.help("Triple, e.g. x86_64-linux-musl"))
407413
.option(cl::Option("format").takes_value()
408-
.help("tar (default) | dir"))
414+
.help("tar (default; .zip for a Windows target) | dir"))
409415
.option(cl::Option("output").short_name('o').takes_value()
410416
.help("Override output path"))
411417
.action(wrap_rc(cmd_pack)))

0 commit comments

Comments
 (0)