[gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/patches/

["Ulrich Müller" <ulm@gentoo.org>]

commit:     39680e44ae7267f09465cef26f156195e55e6483
Author:     Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Sat Apr 10 00:15:09 2021 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Fri Jun 18 06:12:36 2021 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=39680e44

ebuild-writing/misc-files/patches: discourage adding comments within patch

We shouldn't add comments (#) within patch changes to source code
(etc) because it's unnecessary noise. Comments *at the top* of the
patch are, of course, welcoome.

Closes: https://github.com/gentoo/devmanual/pull/217
Signed-off-by: Sam James <sam <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>

 ebuild-writing/misc-files/patches/text.xml | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/ebuild-writing/misc-files/patches/text.xml b/ebuild-writing/misc-files/patches/text.xml
index 8d54dfd..05052e6 100644
--- a/ebuild-writing/misc-files/patches/text.xml
+++ b/ebuild-writing/misc-files/patches/text.xml
@@ -293,6 +293,14 @@ files automatically. Alternatively, you can specify the <c>-E</c> option with
 <c>eapply</c> if you want to remove an empty file.
 </p>
 
+<p>
+Removed lines should not appear in the patch because they are commented <d/>
+just remove them entirely. Patches show removed lines by prefixing them with
+a <c>-</c>, so no information is lost by simply deleting lines rather than
+commenting them out (which adds noise). This makes the patch shorter and
+more readable.
+</p>
+
 <p>
 The following function (for your interactive shell, not for the ebuild) will
 help deleting these things: