Skip to content

Manual: improve documentation on checksum #61715

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gschwaer wants to merge 4 commits into
base: master
Choose a base branch
from
+5 −3
Open

Manual: improve documentation on checksum #61715

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d3a6c9f
Manual: fix formatting on distfiles example
gschwaer Jul 29, 2026
67bfc35
Manual: use real checksum example and drop quotes
gschwaer Jul 29, 2026
d530faa
Manual: add manual checksum command
gschwaer Jul 28, 2026
8d9a44b
Manual: update checksum command
gschwaer Jul 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions Manual.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -512,7 +512,7 @@ can be separated by whitespaces. The files must end in `.tar.lzma`, `.tar.xz`,
`.txz`, `.tar.bz2`, `.tbz`, `.tar.gz`, `.tgz`, `.gz`, `.bz2`, `.tar` or
`.zip`. To define a target filename, append `>filename` to the URL.
Example:
distfiles="http://foo.org/foo-1.0.tar.gz http://foo.org/bar-1.0.tar.gz>bar.tar.gz"
`distfiles="http://foo.org/foo-1.0.tar.gz http://foo.org/bar-1.0.tar.gz>bar.tar.gz"`.

To avoid repetition, several variables for common hosting sites
exist:
Expand All @@ -536,14 +536,16 @@ Example:

- `checksum` The `sha256` digests matching `${distfiles}`. Multiple files can be
separated by blanks. Please note that the order must be the same than
was used in `${distfiles}`. Example: `checksum="kkas00xjkjas"`
was used in `${distfiles}`. You can manually generate the checksum using
`xbps-digest <distfile>`.
Example: `checksum=ee43eb65b005b1adf2914a8e462466d0cc4b4b639bf7ba1e62741f2ab2a6fb0f`.

If a distfile changes its checksum for every download because it is packaged
on the fly on the server, like e.g. snapshot tarballs from any of the
`https://*.googlesource.com/` sites, the checksum of the `archive contents`
can be specified by prepending a commercial at (@).
For tarballs you can find the contents checksum by using the command
`tar xf <tarball.ext> --to-stdout | sha256sum`.
`tar xf <tarball.ext> --to-stdout | xbps-digest`.

- `wrksrc` The directory name where the package sources are extracted, set to `${pkgname}-${version}`.

Expand Down