diff options
| author |   Alessandro Barbieri <lssndrbarbieri@gmail.com> | 2021-07-26 01:49:31 +0200 |
|---|---|---|
| committer | Alessandro Barbieri <lssndrbarbieri@gmail.com> | 2021-07-26 01:49:31 +0200 |
| commit | f8caf432510f5a226f59b82de5b024cc50d2fe32 (patch) | |
| tree | 9dad5f5600310a15620a55b6d32e2dca54f36333 /CONTRIBUTING.md | |
| parent | CONTRIBUTING.md: add list of undesired python dependencies (diff) | |
| download | guru-f8caf432510f5a226f59b82de5b024cc50d2fe32.tar.gz guru-f8caf432510f5a226f59b82de5b024cc50d2fe32.tar.bz2 guru-f8caf432510f5a226f59b82de5b024cc50d2fe32.zip | |
CONTRIBUTING.md: mention the clean patch guide
Closes: https://github.com/gentoo/guru/issues/28
Signed-off-by: Alessandro Barbieri <lssndrbarbieri@gmail.com>
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0fcc70708..2719cc93b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -87,3 +87,7 @@ See the [dev manual](https://devmanual.gentoo.org/eclass-reference/distutils-r1. Installation of small files, like documentation, completions, man pages, etc, does not have to be toggle-able with an USE flag. Instead, just install these files unconditionally. This avoids unnecessary recompilations when an user forgot to enable a flag that installs a small file. The same holds for optional runtime dependencies. It is not necessary to introduce a USE flag, that does not alter the compiled binary and just pulls in an extra optional runtime dependency. Instead, you can notify the user of these optional runtime dependencies with the `optfeature` function from the [optfeature](https://devmanual.gentoo.org/eclass-reference/optfeature.eclass/) eclass (early from currently deprecated [eutils](https://devmanual.gentoo.org/eclass-reference/eutils.eclass/) eclass). If, for whatever reason, it is still desired to introduce an USE flag for optional runtime dependencies, one can still use the `optfeature` function as well to allow the user to choose to avoid recompiling a package. + +- #### Clean your patches + +See the [dev manual](https://devmanual.gentoo.org/ebuild-writing/misc-files/patches/#clean-patch-howto) for a guide on how to write clean patches |