aboutsummaryrefslogtreecommitdiffhomepage
path: root/Manual.md
diff options
context:
space:
mode:
authorPiotr Wójcik <chocimier@tlen.pl>2021-04-20 00:05:49 +0200
committerPiotr <chocimier@tlen.pl>2021-04-26 18:49:15 +0200
commitaa83569fcbd0c9475f49915baa83567eefd2bd7d (patch)
tree861c43ebfd6461a7d806a6828588fe123cb68569 /Manual.md
parentkblocks: update to 21.04.0. (diff)
xbps-src: add make_check=ci-skip
Diffstat (limited to 'Manual.md')
-rw-r--r--Manual.md14
1 files changed, 9 insertions, 5 deletions
diff --git a/Manual.md b/Manual.md
index 8c2afbaca71..73cd9088f9b 100644
--- a/Manual.md
+++ b/Manual.md
@@ -176,9 +176,8 @@ can be used to perform other operations before configuring the package.
- `check` This optional phase checks the result of the `build` phase by running the testsuite provided by the package.
If the default `do_check` function provided by the build style doesn't do anything, the template should set
`make_check_target` and/or `make_check_args` appropriately or define its own `do_check` function. If tests take too long
-or can't run in all environments, they should be run only if `XBPS_CHECK_PKGS` is `full`, which means they should either
-be under a `[ "$XBPS_CHECK_PKGS" = full ]` conditional (especially useful with custom `do_check`) or `make_check=extended`
-should be set in the template.
+or can't run in all environments, `make_check` should be set to fitting value or
+`do_check` should be customized to limit testsuite unless `XBPS_CHECK_PKGS` is `full`.
- `install` This phase installs the `package files` into the package destdir `<masterdir>/destdir/<pkgname>-<version>`,
via `make install` or any other compatible method.
@@ -606,10 +605,15 @@ patches to the package sources during `do_patch()`. Patches are stored in
- `disable_parallel_build` If set the package won't be built in parallel
and `XBPS_MAKEJOBS` has no effect.
-- `make_check` Sets the cases in which the `check` phase is run. Can be `yes` (the default) to run if
-`XBPS_CHECK_PKGS` is set, `extended` to run if `XBPS_CHECK_PKGS` is `full` and `no` to never run.
+- `make_check` Sets the cases in which the `check` phase is run.
This option should usually be accompanied by a comment explaining why it was set, especially when
set to `no`.
+Allowed values:
+ - `yes` (the default) to run if `XBPS_CHECK_PKGS` is set.
+ - `extended` to run if `XBPS_CHECK_PKGS` is `full`.
+ - `ci-skip` to run locally if `XBPS_CHECK_PKGS` is set, but not as part of pull request checks.
+ - `no` to never run.
+
- `keep_libtool_archives` If enabled the `GNU Libtool` archives won't be removed. By default those
files are always removed automatically.