From d4396756d6171044be884a23658d5322dda16e5a Mon Sep 17 00:00:00 2001 From: Arsen Musayelyan Date: Sun, 29 Jan 2023 17:54:05 -0800 Subject: [PATCH] Update docs for new download system --- docs/packages/build-scripts.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/packages/build-scripts.md b/docs/packages/build-scripts.md index d641b30..3fb0d3c 100644 --- a/docs/packages/build-scripts.md +++ b/docs/packages/build-scripts.md @@ -168,7 +168,7 @@ The `replaces` array contains the packages that are replaced by this package. Ge The `sources` array contains URLs which are downloaded into `$srcdir` before the build starts. -If the URL provided is an archive or compressed file, it will be extracted. To disable this, add the `~archive=false` query parameter. Example: +If the URL provided is an archive or compressed file, it will be extracted. To disable this, add the `~postproc=false` (`postproc` stands for postprocessing) query parameter. Example: Extracted: ```text @@ -177,25 +177,24 @@ https://example.com/archive.tar.gz Not extracted: ```text -https://example.com/archive.tar.gz?~archive=false +https://example.com/archive.tar.gz?~postproc=false ``` If the URL scheme starts with `git+`, the source will be downloaded as a git repo. The git download mode supports multiple parameters: -- `~tag`: Specify which tag of the repo to check out. -- `~branch`: Specify which branch of the repo to check out. -- `~commit`: Specify which commit of the repo to check out. +- `~rev`: Specify which revision of the repo to check out. - `~depth`: Specify what depth should be used when cloning the repo. Must be an integer. - `~name`: Specify the name of the directory into which the git repo should be cloned. +- `~recursive`: If set to true, submodules will be cloned recursively. It is false by default. Examples: ```text -git+https://gitea.arsenm.dev/Arsen6331/itd?~branch=resource-loading&~depth=1 +git+https://gitea.arsenm.dev/Arsen6331/itd?~rev=resource-loading&~depth=1 ``` ```text -git+https://gitea.arsenm.dev/Arsen6331/lure?~tag=v0.0.1 +git+https://gitea.arsenm.dev/Arsen6331/lure?~rev=v0.0.1&~recursive=true ``` ### checksums