mirror/zig
1
0
Fork 0
mirror of https://github.com/ziglang/zig.git synced 2025-12-06 06:13:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Expand zig fetch usage help doc to explain URL (#22850)

Browse Source 
The current zig fetch help docs tell the user to specify a package's URL, but it's unclear what the URL should be.

This change expands the help output to explain what URLs the zig fetch command can handle and provides examples of valid URLs.

Related: #20096

A git bundle file seems to be the more accurate term, as it's what git uses in its documentation: https://git-scm.com/docs/git-bundle
This commit is contained in:
Michael Lynch 2025-02-13 16:06:10 -05:00 committed by GitHub
parent bffbc918ee
commit cb5547e3de
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/main.zig
View File

@ -6956,6 +6956,16 @@ const usage_fetch =
\\Usage: zig fetch [options] <path> \\Usage: zig fetch [options] <path>
\\ \\
\\ Copy a package into the global cache and print its hash. \\ Copy a package into the global cache and print its hash.
\\ <url> must point to one of the following:
\\ - A git+http / git+https server for the package
\\ - A tarball file (with or without compression) containing
\\ package source
\\ - A git bundle file containing package source
\\
\\Examples:
\\
\\ zig fetch --save git+https://example.com/andrewrk/fun-example-tool.git
\\ zig fetch --save https://example.com/andrewrk/fun-example-tool/archive/refs/heads/master.tar.gz
\\ \\
\\Options: \\Options:
\\ -h, --help Print this help and exit \\ -h, --help Print this help and exit