diff options
| author |  Érico Rolim <erico.erc@gmail.com> | 2021-01-29 21:47:59 -0300 |
|---|---|---|
| committer |  Érico Nogueira Rolim <34201958+ericonr@users.noreply.github.com> | 2021-02-11 02:40:09 -0300 |
| commit | 2a748e7e6d9727a7e921d6b9a163e0eb17be98b9 (patch) | |
| tree | 9130b04f4868a8baa76b2c4813eaa8530b1a5ccf /Manual.md | |
| parent | xbps-src: add -K option to getopt string. (diff) | |
xbps-src/libexec: add make_check option.
Allows a template to define in which circumstances its do_check phase
should run, without requiring custom do_check definitions in each
template (also makes it easier to change how build styles do things
without checking as many templates).
Add to Manual and CONTRIBUTING as well.
Diffstat (limited to 'Manual.md')
| -rw-r--r-- | Manual.md | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/Manual.md b/Manual.md index ed73ec338fa..acd23a32b42 100644 --- a/Manual.md +++ b/Manual.md @@ -166,7 +166,12 @@ can be used to perform other operations before configuring the package. - `build` This phase compiles/prepares the `source files` via `make` or any other compatible method. -- `check` This optional phase checks the result of the `build` phase for example by running `make -k check`. +- `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. - `install` This phase installs the `package files` into the package destdir `<masterdir>/destdir/<pkgname>-<version>`, via `make install` or any other compatible method. @@ -589,6 +594,11 @@ 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. +This option should usually be accompanied by a comment explaining why it was set, especially when +set to `no`. + - `keep_libtool_archives` If enabled the `GNU Libtool` archives won't be removed. By default those files are always removed automatically. |