From 95d215d8fac840f2353213374c87f0bc055e8ec1 Mon Sep 17 00:00:00 2001
From: Russ Allbery <rra@debian.org>
Date: Mon, 19 Jul 2010 10:29:41 -0700
Subject: [PATCH] Only dpkg-gencontrol supports variable substitution

dpkg-genchanges and dpkg-source don't use substvars, so stop claiming
that they do.  Wording from Charles Plessy.
---
 debian/changelog         |  5 +++++
 policy.sgml              | 12 ++++++------
 upgrading-checklist.sgml |  5 +++++
 3 files changed, 16 insertions(+), 6 deletions(-)

diff --git a/debian/changelog b/debian/changelog
index 383b607..2f854ad 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -63,6 +63,11 @@ debian-policy (3.9.1.0) UNRELEASED; urgency=low
     Seconded: Raphaël Hertzog <hertzog@debian.org>
     Seconded: Emilio Pozuelo Monfort <pochu27@gmail.com>
     Closes: #509933
+  * Policy: Only dpkg-gencontrol supports variable substitutions
+    Wording: Charles Plessy <plessy@debian.org>
+    Seconded: Emilio Pozuelo Monfort <pochu@debian.org>
+    Seconded: Guillem Jover <guillem@debian.org>
+    Closes: #589609
   * Set the version of the Perl Policy to match the version of the Policy
     package.
   * Explain the Perl module package naming policy more explicitly and
diff --git a/policy.sgml b/policy.sgml
index 4ea42e8..847f716 100644
--- a/policy.sgml
+++ b/policy.sgml
@@ -2218,16 +2218,16 @@ endif
 	<heading>Variable substitutions: <file>debian/substvars</file></heading>
 
 	<p>
-	  When <prgn>dpkg-gencontrol</prgn>,
-	  <prgn>dpkg-genchanges</prgn> and <prgn>dpkg-source</prgn>
-	  generate control files, they perform variable substitutions
-	  on their output just before writing it.  Variable
+	  When <prgn>dpkg-gencontrol</prgn>
+	  generates <qref id="binarycontrolfiles">binary package control
+	  files</qref> (<file>DEBIAN/control</file>), it performs variable
+	  substitutions on its output just before writing it.  Variable
 	  substitutions have the form <tt>${<var>variable</var>}</tt>.
 	  The optional file <file>debian/substvars</file> contains
 	  variable substitutions to be used; variables can also be set
 	  directly from <file>debian/rules</file> using the <tt>-V</tt>
-	  option to the source packaging commands, and certain
-	  predefined variables are also available.
+	  option to the source packaging commands, and certain predefined
+	  variables are also available.
 	</p>
 
 	<p>
diff --git a/upgrading-checklist.sgml b/upgrading-checklist.sgml
index 3dc378c..a147fca 100644
--- a/upgrading-checklist.sgml
+++ b/upgrading-checklist.sgml
@@ -50,6 +50,11 @@ Not yet released.
   to <prgn>dpkg-divert</prgn> when creating or removing diversions and
   must not use <tt>--local</tt>.
   </item>
+<tag>4.10</tag>
+  <item>Only <prgn>dpkg-gencontrol</prgn> supports variable substitution.
+  <prgn>dpkg-genchanges</prgn> (for <file>*.changes</file>)
+  and <prgn>dpkg-source</prgn> (for <file>*.dsc</file>) do not.
+  </item>
 <tag>7.1</tag>
   <item>Architecture restrictions and wildcards are also allowed in binary
   package relationships provided that the binary package is not
-- 
2.39.5