summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTobias Christiansen <tobyase@serenityos.org>2022-03-11 21:19:33 +0100
committerLinus Groh <mail@linusgroh.de>2022-03-11 21:26:56 +0100
commitedcec09aa421c19b3f66f95cd61702f98cfad2d2 (patch)
tree977c640330d91e8283058ccc6fa36f4fa554dbba
parent9412af1194ecd011abf300471fb286f210c744a1 (diff)
downloadserenity-edcec09aa421c19b3f66f95cd61702f98cfad2d2.zip
Meta: Update hashes in Port's README
Only 'sha256' or 'sig' are allowed in the 'auth_type' field in order for the linter to pass. Reflect that into the README and give a description on what to do to create a hash. Also expand the examples to include a SHA256 hash.
-rw-r--r--Ports/README.md16
1 files changed, 12 insertions, 4 deletions
diff --git a/Ports/README.md b/Ports/README.md
index f6715f087a..5c3dea8021 100644
--- a/Ports/README.md
+++ b/Ports/README.md
@@ -153,13 +153,16 @@ auth_opts="foo-${version}.tar.xz.asc foo-${version}.tar.xz"
The type of file validation to use, can be one of:
-- `md5`: Use MD5 hashes defined in [`files`](#files)
- `sha256`: Use SHA256 hashes defined in [`files`](#files)
-- `sha1`: Use SHA1 hashes defined in [`files`](#files)
- `sig`: Use PGP signatures (see [`auth_opts`](#auth_opts))
-Defaults to `md5`, most ports use `sig` though as `.asc` files are widely
-available.
+Most ports use `sig` as `.asc` files are widely available.
+
+This _has_ to be specified in order for `lint-ports` to pass.
+
+If no signature or hash is provided by the author of the files, just create the
+hash yourself by calling `sha256sum` on the downloaded file and specifying the
+hash along with the [`files`](#files).
#### `configopts`
@@ -213,10 +216,15 @@ MD5, SHA1, or SHA256 hash that will be used for verification when
For example:
+_With PGP signatures_
```bash
files="https://example.com/foo-${version}.tar.xz foo-${version}.tar.xz
https://example.com/foo-${version}.tar.xz.asc foo-${version}.tar.xz.asc"
```
+_With a SHA256 hash_
+```bash
+files="https://example.com/foo-${version}.tar.xz foo-${version}.tar.xz 9acd50f9a2af37e471f761c3fe7b8dea5617e51dac802fe6c177b74abf0abb5a"
+```
If a file is a compressed tar archive, a gzip compressed file or a zip
compressed file, it will be extracted.