[PR PATCH] Manual.md: document the check functions

[PR PATCH] Manual.md: document the check functions

[0x5c]

[-- Attachment #1: Type: text/plain, Size: 1446 bytes --]

There is a new pull request by 0x5c against master on the void-packages repository

https://github.com/0x5c/void-packages manual-post-functions
https://github.com/void-linux/void-packages/pull/36412

Manual.md: document the check functions
The pre_/do_/post_check functions were not listed in the list of building
phase functions, and were not mentioned elsewhere (do_check was mentioned
once). This documents their existence.

<!-- Uncomment relevant sections and delete options which are not applicable -->

#### Testing the changes
- I tested the changes in this PR: **YES**

<!--
#### New package
- This new package conforms to the [quality requirements](https://github.com/void-linux/void-packages/blob/master/Manual.md#quality-requirements): **YES**|**NO**
-->

<!-- Note: If the build is likely to take more than 2 hours, please add ci skip tag as described in
https://github.com/void-linux/void-packages/blob/master/CONTRIBUTING.md#continuous-integration
and test at least one native build and, if supported, at least one cross build.
Ignore this section if this PR is not skipping CI.
-->
<!-- 
#### Local build testing
- I built this PR locally for my native architecture, (ARCH-LIBC)
- I built this PR locally for these architectures (if supported. mark crossbuilds):
  - aarch64-musl
  - armv7l
  - armv6l-musl
-->


A patch file from https://github.com/void-linux/void-packages/pull/36412.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-manual-post-functions-36412.patch --]
[-- Type: text/x-diff, Size: 1118 bytes --]

From ec69d48667280d7dc71aa6b42849b007a0b7a08f Mon Sep 17 00:00:00 2001
From: 0x5c <dev@0x5c.io>
Date: Wed, 30 Mar 2022 02:05:43 -0400
Subject: [PATCH] Manual.md: document the check functions

The pre_/do_/post_check functions were not listed in the list of building
phase functions, and were not mentioned elsewhere (do_check was mentioned
once). This documents their existence.
---
 Manual.md | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/Manual.md b/Manual.md
index af5f698debae..d0d05da38025 100644
--- a/Manual.md
+++ b/Manual.md
@@ -1101,7 +1101,13 @@ still be passed in if it's a GNU configure script.
 
 - `post_build()` Actions to execute after `do_build()`.
 
-- `pre_install()` Actions to execute after `post_build()`.
+- `pre_check()` Actions to execute after `post_build()`.
+
+- `do_check()` Actions to execute to run checks for the package.
+
+- `post_check()` Actions to execute after `do_check()`.
+
+- `pre_install()` Actions to execute after `post_build()` or `post_check()`.
 
 - `do_install()` Actions to execute to install the package files into the `fake destdir`.
 

Re: [PR REVIEW] Manual.md: document the check functions

[Chocimier]

[-- Attachment #1: Type: text/plain, Size: 237 bytes --]

New review comment by Chocimier on void-packages repository

https://github.com/void-linux/void-packages/pull/36412#discussion_r838836024

Comment:
Check phase is no more optional than any other, please mention only one post_check here.

Re: [PR REVIEW] Manual.md: document the check functions

[0x5c]

[-- Attachment #1: Type: text/plain, Size: 390 bytes --]

New review comment by 0x5c on void-packages repository

https://github.com/void-linux/void-packages/pull/36412#discussion_r839038013

Comment:
I was under the impression from the manual's description of `make_check` that `*_check()` won't always run. Same impression from the complete lack of running checks when doing anything but `xbps-src check` in an unmodified void-packages checkout.

Re: [PR REVIEW] Manual.md: document the check functions

[Chocimier]

[-- Attachment #1: Type: text/plain, Size: 405 bytes --]

New review comment by Chocimier on void-packages repository

https://github.com/void-linux/void-packages/pull/36412#discussion_r839835487

Comment:
That's true, yet no different from other phases. If template define no `do_configure` and no `post_configure`, the `pre_build` still do run.
The list is about relative order and purpose, not special cases like disabled tests or continuing build with `-f`.

Re: [PR REVIEW] Manual.md: document the check functions

[0x5c]

[-- Attachment #1: Type: text/plain, Size: 164 bytes --]

New review comment by 0x5c on void-packages repository

https://github.com/void-linux/void-packages/pull/36412#discussion_r839901466

Comment:
I see, will fix it

Re: [PR PATCH] [Updated] Manual.md: document the check functions

[0x5c]

[-- Attachment #1: Type: text/plain, Size: 1451 bytes --]

There is an updated pull request by 0x5c against master on the void-packages repository

https://github.com/0x5c/void-packages manual-post-functions
https://github.com/void-linux/void-packages/pull/36412

Manual.md: document the check functions
The pre_/do_/post_check functions were not listed in the list of building
phase functions, and were not mentioned elsewhere (do_check was mentioned
once). This documents their existence.

<!-- Uncomment relevant sections and delete options which are not applicable -->

#### Testing the changes
- I tested the changes in this PR: **YES**

<!--
#### New package
- This new package conforms to the [quality requirements](https://github.com/void-linux/void-packages/blob/master/Manual.md#quality-requirements): **YES**|**NO**
-->

<!-- Note: If the build is likely to take more than 2 hours, please add ci skip tag as described in
https://github.com/void-linux/void-packages/blob/master/CONTRIBUTING.md#continuous-integration
and test at least one native build and, if supported, at least one cross build.
Ignore this section if this PR is not skipping CI.
-->
<!-- 
#### Local build testing
- I built this PR locally for my native architecture, (ARCH-LIBC)
- I built this PR locally for these architectures (if supported. mark crossbuilds):
  - aarch64-musl
  - armv7l
  - armv6l-musl
-->


A patch file from https://github.com/void-linux/void-packages/pull/36412.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-manual-post-functions-36412.patch --]
[-- Type: text/x-diff, Size: 1100 bytes --]

From 8b5fc7a7b28d177e68c779c7f8d5ee68f8b8e502 Mon Sep 17 00:00:00 2001
From: 0x5c <dev@0x5c.io>
Date: Wed, 30 Mar 2022 02:05:43 -0400
Subject: [PATCH] Manual.md: document the check functions

The pre_/do_/post_check functions were not listed in the list of building
phase functions, and were not mentioned elsewhere (do_check was mentioned
once). This documents their existence.
---
 Manual.md | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/Manual.md b/Manual.md
index af5f698debae..8ec755499bbe 100644
--- a/Manual.md
+++ b/Manual.md
@@ -1101,7 +1101,13 @@ still be passed in if it's a GNU configure script.
 
 - `post_build()` Actions to execute after `do_build()`.
 
-- `pre_install()` Actions to execute after `post_build()`.
+- `pre_check()` Actions to execute after `post_build()`.
+
+- `do_check()` Actions to execute to run checks for the package.
+
+- `post_check()` Actions to execute after `do_check()`.
+
+- `pre_install()` Actions to execute after `post_check()`.
 
 - `do_install()` Actions to execute to install the package files into the `fake destdir`.
 

Re: Manual.md: document the check functions

[Chocimier]

[-- Attachment #1: Type: text/plain, Size: 151 bytes --]

New comment by Chocimier on void-packages repository

https://github.com/void-linux/void-packages/pull/36412#issuecomment-1086674439

Comment:
Thanks!

Re: [PR PATCH] [Merged]: Manual.md: document the check functions

[Chocimier]

[-- Attachment #1: Type: text/plain, Size: 1287 bytes --]

There's a merged pull request on the void-packages repository

Manual.md: document the check functions
https://github.com/void-linux/void-packages/pull/36412

Description:
The pre_/do_/post_check functions were not listed in the list of building
phase functions, and were not mentioned elsewhere (do_check was mentioned
once). This documents their existence.

<!-- Uncomment relevant sections and delete options which are not applicable -->

#### Testing the changes
- I tested the changes in this PR: **YES**

<!--
#### New package
- This new package conforms to the [quality requirements](https://github.com/void-linux/void-packages/blob/master/Manual.md#quality-requirements): **YES**|**NO**
-->

<!-- Note: If the build is likely to take more than 2 hours, please add ci skip tag as described in
https://github.com/void-linux/void-packages/blob/master/CONTRIBUTING.md#continuous-integration
and test at least one native build and, if supported, at least one cross build.
Ignore this section if this PR is not skipping CI.
-->
<!-- 
#### Local build testing
- I built this PR locally for my native architecture, (ARCH-LIBC)
- I built this PR locally for these architectures (if supported. mark crossbuilds):
  - aarch64-musl
  - armv7l
  - armv6l-musl
-->