summaryrefslogtreecommitdiff
path: root/doc/guide
diff options
context:
space:
mode:
authorrillig <rillig@pkgsrc.org>2018-11-05 20:36:35 +0000
committerrillig <rillig@pkgsrc.org>2018-11-05 20:36:35 +0000
commitbf07f78b56f0d606d01cfa9c3d297f43ff526fee (patch)
treecd36b99d34eec8de412e2956ad23e178c7c33f78 /doc/guide
parent9e1f862b9a733314385a0322f929b8fa9d79bdca (diff)
downloadpkgsrc-bf07f78b56f0d606d01cfa9c3d297f43ff526fee.tar.gz
doc/guide: document the purpose of distinfo storing patch checksums
See https://mail-index.netbsd.org/tech-pkg/2018/11/04/msg020426.html.
Diffstat (limited to 'doc/guide')
-rw-r--r--doc/guide/files/components.xml9
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/guide/files/components.xml b/doc/guide/files/components.xml
index 86720496f43..279017a5eb4 100644
--- a/doc/guide/files/components.xml
+++ b/doc/guide/files/components.xml
@@ -1,4 +1,4 @@
-<!-- $NetBSD: components.xml,v 1.55 2018/07/24 23:46:15 maya Exp $ -->
+<!-- $NetBSD: components.xml,v 1.56 2018/11/05 20:36:35 rillig Exp $ -->
<chapter id="components"> <?dbhtml filename="components.html"?>
<title>Package components - files, directories and contents</title>
@@ -202,7 +202,12 @@ converters games mbone print x11
<para>The <filename>distinfo</filename> file also contains the
checksums for all the patches found in the
<filename>patches</filename> directory (see <xref
- linkend="components.patches"/>).</para>
+ linkend="components.patches"/>). These checksums ensure that patches
+ are only applied intentionally and that they don't accidentally change,
+ e.g. when merging different changes together. They also make sure that
+ new patches are actually added to CVS and old ones are removed.
+ Too see whether the patches and the <filename>distinfo</filename> file
+ match, run <command>pkglint</command> after changing the patches.</para>
<para>To regenerate the <filename>distinfo</filename> file, use the
<command>make distinfo</command> command.</para>