Bug#572253: debian-policy: example for usage of Replaces: when a package is split

[Russ Allbery <rra@debian.org>]

Uwe Kleine-König <u.kleine-koenig@pengutronix.de> writes:

> I asked in #debian-mentors about the usage of Replaces: and Conflicts:
> when a package is split.  Cyril suggested to provide an example in the
> policy for that.

> The patch below isn't tested at all, but should be human parsable to
> understand the suggestion.

Thanks!  I've added the following example for the next release.

diff --git a/policy.sgml b/policy.sgml
index 02d6f8d..da3a687 100644
--- a/policy.sgml
+++ b/policy.sgml
@@ -4744,6 +4744,20 @@ Provides: bar
 	  </p>
 
 	  <p>
+	    For example, if a package <package>foo</package> is split
+	    into <package>foo</package> and <package>foo-data</package>
+	    starting at version 1.2-3, <package>foo-data</package> should
+	    have the field
+	    <example compact="compact">
+Replaces: foo (&lt;&lt; 1.2-3)
+	    </example>
+	    in its control file.  The package <package>foo</package>
+	    doesn't need any special control fields in this example,
+	    although would generally depend on or
+	    recommend <package>foo-data</package>.
+	  </p>
+
+	  <p>
 	    If a package is completely replaced in this way, so that
 	    <prgn>dpkg</prgn> does not know of any files it still
 	    contains, it is considered to have "disappeared".  It will

-- 
Russ Allbery (rra@debian.org)               <http://www.eyrie.org/~eagle/>