From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id EC7611382C5 for ; Fri, 18 Jun 2021 06:14:22 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 38738E0857; Fri, 18 Jun 2021 06:13:51 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [IPv6:2001:470:ea4a:1:5054:ff:fec7:86e4]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id B5CF3E0857 for ; Fri, 18 Jun 2021 06:13:50 +0000 (UTC) Received: from oystercatcher.gentoo.org (oystercatcher.gentoo.org [148.251.78.52]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id 761DC340961 for ; Fri, 18 Jun 2021 06:13:49 +0000 (UTC) Received: from localhost.localdomain (localhost [IPv6:::1]) by oystercatcher.gentoo.org (Postfix) with ESMTP id AD9907AC for ; Fri, 18 Jun 2021 06:13:47 +0000 (UTC) From: "Ulrich Müller" To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Ulrich Müller" Message-ID: <1623996756.39680e44ae7267f09465cef26f156195e55e6483.ulm@gentoo> Subject: [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/misc-files/patches/ X-VCS-Repository: proj/devmanual X-VCS-Files: ebuild-writing/misc-files/patches/text.xml X-VCS-Directories: ebuild-writing/misc-files/patches/ X-VCS-Committer: ulm X-VCS-Committer-Name: Ulrich Müller X-VCS-Revision: 39680e44ae7267f09465cef26f156195e55e6483 X-VCS-Branch: master Date: Fri, 18 Jun 2021 06:13:47 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org X-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply X-Archives-Salt: d6574212-eaae-4dcf-bbc3-4ae158ddc5f1 X-Archives-Hash: 6dc1beb665b2774119dec8c929bc024f commit: 39680e44ae7267f09465cef26f156195e55e6483 Author: Sam James gentoo org> AuthorDate: Sat Apr 10 00:15:09 2021 +0000 Commit: Ulrich Müller gentoo 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 gentoo.org> Signed-off-by: Ulrich Müller 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 -E option with eapply if you want to remove an empty file.

+

+Removed lines should not appear in the patch because they are commented +just remove them entirely. Patches show removed lines by prefixing them with +a -, 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. +

+

The following function (for your interactive shell, not for the ebuild) will help deleting these things: