[pkgsrc/trunk]: pkgsrc/doc/guide/files doc/guide: add an example for SUPERSEDES

[rillig <rillig%pkgsrc.org@localhost>]

details:   https://anonhg.NetBSD.org/pkgsrc/rev/4b737ad63806
branches:  trunk
changeset: 407486:4b737ad63806
user:      rillig <rillig%pkgsrc.org@localhost>
date:      Sun Jan 05 21:35:33 2020 +0000

description:
doc/guide: add an example for SUPERSEDES

This example makes it easier to see that the assignment operator should
always be += instead of a simple =. Also remove the word dewey since that
is a classification scheme for libraries, not a versioning scheme.

diffstat:

 doc/guide/files/submit.xml |  16 +++++++++++-----
 1 files changed, 11 insertions(+), 5 deletions(-)

diffs (37 lines):

diff -r 5e076838d6f8 -r 4b737ad63806 doc/guide/files/submit.xml
--- a/doc/guide/files/submit.xml        Sun Jan 05 21:19:40 2020 +0000
+++ b/doc/guide/files/submit.xml        Sun Jan 05 21:35:33 2020 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: submit.xml,v 1.33 2017/09/18 14:25:27 wiz Exp $ -->
+<!-- $NetBSD: submit.xml,v 1.34 2020/01/05 21:35:33 rillig Exp $ -->
 
 <chapter id="submit"> <?dbhtml filename="submit.html"?>
 <title>Submitting and Committing</title>
@@ -209,17 +209,23 @@
 
 <para>Renaming packages is not recommended.</para>
 
-
 <para>When renaming packages, be sure to fix any references to old name
   in other Makefiles, options, buildlink files, etc.</para>
 
-<para>Also When renaming a package, please define
-  <varname>SUPERSEDES</varname> to the package name and dewey version
-  pattern(s) of the previous package name.
+<para>
+  Also when renaming a package, please add
+  the package name and version pattern(s) of the previous package
+  to <varname>SUPERSEDES</varname>.
   This may be repeated for multiple renames.
   The new package would be an exact replacement.
+  Example:
 </para>
 
+<programlisting>
+SUPERSEDES+=    p5-IO-Compress-Zlib&lt;2.017
+SUPERSEDES+=    optcomp-[0-9]*
+</programlisting>
+
 <para>Note that <quote>successor</quote> in the
   CHANGES-<replaceable>YYYY</replaceable> file doesn't necessarily
   mean that it <emphasis>supersedes</emphasis>, as that successor may