| 1 |
commit: 9a95bef60eb78cba7f8e8c6b88476f009721fb4f |
| 2 |
Author: Anna (cybertailor) Vyalkova <cyber+gentoo <AT> sysrq <DOT> in> |
| 3 |
AuthorDate: Wed Feb 2 08:05:43 2022 +0000 |
| 4 |
Commit: Anna Vyalkova <cyber+gentoo <AT> sysrq <DOT> in> |
| 5 |
CommitDate: Wed Feb 2 08:11:08 2022 +0000 |
| 6 |
URL: https://gitweb.gentoo.org/repo/proj/guru.git/commit/?id=9a95bef6 |
| 7 |
|
| 8 |
CONTRIBUTING.md: ebuild testing |
| 9 |
|
| 10 |
Signed-off-by: Anna (cybertailor) Vyalkova <cyber+gentoo <AT> sysrq.in> |
| 11 |
|
| 12 |
CONTRIBUTING.md | 6 ++++++ |
| 13 |
1 file changed, 6 insertions(+) |
| 14 |
|
| 15 |
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md |
| 16 |
index 108da9e93..456282084 100644 |
| 17 |
--- a/CONTRIBUTING.md |
| 18 |
+++ b/CONTRIBUTING.md |
| 19 |
@@ -84,6 +84,12 @@ Running `repoman -dx full` in the directory your ebuild is in will preform some |
| 20 |
|
| 21 |
Pkgcheck does even more checks than repoman. While it is good practice to make repoman as happy as possible, it is not necessary to fix *every* issue that pkgcheck reports. Because pkgcheck is *very* strict. That being said, pkgcheck is a very useful tool to perfect your ebuilds. |
| 22 |
|
| 23 |
+- #### Establish your package testing workflow |
| 24 |
+ |
| 25 |
+There are [make.conf flags](https://wiki.gentoo.org/wiki/Package_testing#make.conf_.26_test.conf) you might want to set to enable more QA checks. |
| 26 |
+ |
| 27 |
+The [app-portage/iwdevtools](https://github.com/ionenwks/iwdevtools) package contains scripts that help with ebuild development: finding incorrect dependencies, detectng [ABI changes](https://devmanual.gentoo.org/general-concepts/slotting/index.html#abi-breakage) etc. |
| 28 |
+ |
| 29 |
- #### Tests and documentation for Python packages. |
| 30 |
|
| 31 |
Many Python packages have tests and documentation. Unlike some other eclasses the [distutils-r1 eclass](https://devmanual.gentoo.org/eclass-reference/distutils-r1.eclass/index.html) does not enable support for these tests automatically. This is because there are multiple test runners available for Python. To enable tests for your Python ebuilds, use the `distutils_enable_tests <test-runner>` function. Similarly, support for documentation building with Sphinx can be added with the `distutils_enable_sphinx <subdir> [--no-autodoc | <plugin-pkgs>...]` function. Please note that these functions already append to IUSE and RESTRICT, so there is no need to specify this manually. |
Archives