CVS commit: pkgsrc/doc/guide/files

["Roland Illig" <rillig%netbsd.org@localhost>]

Module Name:    pkgsrc
Committed By:   rillig
Date:           Sun Jan  5 21:35:33 UTC 2020

Modified Files:
        pkgsrc/doc/guide/files: submit.xml

Log Message:
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.


To generate a diff of this commit:
cvs rdiff -u -r1.33 -r1.34 pkgsrc/doc/guide/files/submit.xml

Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.

Modified files:

Index: pkgsrc/doc/guide/files/submit.xml
diff -u pkgsrc/doc/guide/files/submit.xml:1.33 pkgsrc/doc/guide/files/submit.xml:1.34
--- pkgsrc/doc/guide/files/submit.xml:1.33      Mon Sep 18 14:25:27 2017
+++ pkgsrc/doc/guide/files/submit.xml   Sun Jan  5 21:35:33 2020
@@ -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 @@ much easier to get wrong than <quote>cvs
 
 <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