1 |
commit: 5296812ec1b0d8155480261a49120b2b9347bd0f |
2 |
Author: Michał Górny <mgorny <AT> gentoo <DOT> org> |
3 |
AuthorDate: Wed Oct 25 07:18:17 2017 +0000 |
4 |
Commit: Michał Górny <mgorny <AT> gentoo <DOT> org> |
5 |
CommitDate: Mon Nov 13 16:07:56 2017 +0000 |
6 |
URL: https://gitweb.gentoo.org/data/glep.git/commit/?id=5296812e |
7 |
|
8 |
glep-0065: Apply suggestions from Michael Orlitzky |
9 |
|
10 |
glep-0065.rst | 21 +++++++++++---------- |
11 |
1 file changed, 11 insertions(+), 10 deletions(-) |
12 |
|
13 |
diff --git a/glep-0065.rst b/glep-0065.rst |
14 |
index a8a7321..af641d7 100644 |
15 |
--- a/glep-0065.rst |
16 |
+++ b/glep-0065.rst |
17 |
@@ -18,9 +18,9 @@ This GLEP provides two kinds of QA check: checks run on the installation image |
18 |
once ``src_install`` returns, and checks run on the live system once |
19 |
``pkg_postinst`` returns. The checks can be provided by the Package Manager, |
20 |
repositories, packages (installed system-wide) and the system administrator. |
21 |
-The QA checks can inspect the installation image or live system respectively, |
22 |
-output and store both user- and machine-oriented QA warning logs, manipulate |
23 |
-the files and abort the install, as necessary. |
24 |
+The QA checks can inspect the installation image or live system, output |
25 |
+and store both user- and machine-oriented QA warning logs, manipulate files |
26 |
+and abort the install. |
27 |
|
28 |
|
29 |
Motivation |
30 |
@@ -34,8 +34,9 @@ the installed files. This is where post-install QA checks become useful. |
31 |
|
32 |
Over time, many different QA checks have been added to Portage. That includes |
33 |
checks corresponding to generic Gentoo rules (like filesystem hierarchy, |
34 |
-security requirements), checks enforcing Gentoo team policies and correct |
35 |
-eclass uses. Some of the checks depend on external tools being present. |
36 |
+security requirements), checks enforcing Gentoo team policies, and checks |
37 |
+enforcing correct eclass usage. Some of the checks depend on external tools |
38 |
+being present. |
39 |
|
40 |
Keeping those checks directly in Portage sources has two major disadvantages: |
41 |
|
42 |
@@ -58,7 +59,7 @@ There are two kinds of QA checks defined in this specification: |
43 |
|
44 |
1. Post-install QA checks (``install-qa-check.d``), |
45 |
|
46 |
-2. Post-merge (postinst) QA checks (``postinst-qa-check.d``). |
47 |
+2. Post-merge QA checks (``postinst-qa-check.d``). |
48 |
|
49 |
The post-install QA checks are are executed after the ``src_install`` ebuild |
50 |
phase finishes but before the binary package is built or the ``pkg_preinst`` |
51 |
@@ -117,7 +118,7 @@ run in an isolated subshell, and therefore can safely alter the environment |
52 |
and change the working directory. QA scripts must always end with a command |
53 |
terminating with a successful exit code. |
54 |
|
55 |
-Aside to the standard PMS functions, two additional commands are provided: |
56 |
+Aside from the standard PMS functions, two additional commands are provided: |
57 |
|
58 |
1. ``eqawarn`` to output QA warnings to user, |
59 |
2. ``eqatag`` to store machine-readable information about QA issues. |
60 |
@@ -150,8 +151,8 @@ Synopsis |
61 |
Tag the package with specific QA issues. The *tag* parameter is |
62 |
a well-defined name identifying specific QA issue. The tag can be additionally |
63 |
associated with some data in key-value form and/or one or more *files*. |
64 |
-The file paths are relative to installation image (``${D}``), and need to |
65 |
-start with a leading slash. |
66 |
+The file paths are relative to the installation root (``${D}`` in post-install |
67 |
+checks or ``${ROOT}`` in post-merge), and need to start with a leading slash. |
68 |
|
69 |
If ``-v`` (verbose) parameter is passed, the function will also output |
70 |
newline-delimited list of files using ``eqawarn``. This is intended |
71 |
@@ -181,7 +182,7 @@ account for various problems caused by the ebuild code up to and including |
72 |
``src_install``, the upstream code executed as part of any of those phases |
73 |
and the supplied files. |
74 |
|
75 |
-Post-postinst QA checks can be used to verify the state of system after |
76 |
+Post-merge QA checks can be used to verify the state of system after |
77 |
the package is merged and its ``pkg_postinst`` phase is executed. They mostly |
78 |
aim to detect missing postinst actions but can do other live system integrity |
79 |
checks. |