diff options
author | reed <reed@pkgsrc.org> | 2009-05-02 16:14:37 +0000 |
---|---|---|
committer | reed <reed@pkgsrc.org> | 2009-05-02 16:14:37 +0000 |
commit | d547799b004296fcbd3fbfa69fb52c9b7aea87b1 (patch) | |
tree | b8e551d288115ca01aaeaa5aaeda4fb227e85ca5 /doc/guide | |
parent | 5282370e78c7b395926c59e5c7ad49d700ff6ddf (diff) | |
download | pkgsrc-d547799b004296fcbd3fbfa69fb52c9b7aea87b1.tar.gz |
Add new metadata: PREV_PKGPATH and SUPERSEDES.
These will be available from pkg_summary(5) database.
To be used to find previous packages when a package is moved
or renamed. (Even though that is not recommended.)
Documented in pkgsrc Guide and in the pkg_summary(5) manual page.
Upcoming commit will have some packages modified to add them.
Diffstat (limited to 'doc/guide')
-rw-r--r-- | doc/guide/files/submit.xml | 43 |
1 files changed, 42 insertions, 1 deletions
diff --git a/doc/guide/files/submit.xml b/doc/guide/files/submit.xml index f7649cd0aa1..eb662c75910 100644 --- a/doc/guide/files/submit.xml +++ b/doc/guide/files/submit.xml @@ -1,4 +1,4 @@ -<!-- $NetBSD: submit.xml,v 1.19 2007/08/15 06:33:46 rillig Exp $ --> +<!-- $NetBSD: submit.xml,v 1.20 2009/05/02 16:14:37 reed Exp $ --> <chapter id="submit"> <?dbhtml filename="submit.html"?> <title>Submitting and Committing</title> @@ -149,9 +149,37 @@ stability is to be preferred above new and possibly untested features.</para> </sect1> +<sect1 id="renaming-package"> +<title>Renaming a package in pkgsrc</title> + +<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. + This may be repeated for multiple renames. + The new package would be an exact replacement. +</para> + +<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 + not be an exact replacement but is a suggestion for the replaced + functionality.</para> + +</sect1> + <sect1 id="moving-package"> <title>Moving a package in pkgsrc</title> +<para>It is preferred that packages are not renamed or moved, but if needed + please follow these steps. +</para> + <orderedlist> <listitem><para>Make a copy of the directory somewhere else.</para></listitem> @@ -166,6 +194,19 @@ instead of <quote>../../category/package</quote>.</para> </listitem> +<listitem><para>In the modified package's Makefile, consider setting +<varname>PREV_PKGPATH</varname> to the previous category/package +pathname. The <varname>PREV_PKGPATH</varname> can be used by tools +for doing an update using pkgsrc building; for example, it can +search the &man.pkg.summary.5; database for <varname>PREV_PKGPATH</varname> +(if no <varname>SUPERSEDES</varname>) and then use the corresponding +new <varname>PKGPATH</varname> for that moved package. Note that +it may have multiple matches, so the tool should also check on the +<varname>PKGBASE</varname> too. The <varname>PREV_PKGPATH</varname> +probably has no value unless <varname>SUPERSEDES</varname> is not +set, i.e. <varname>PKGBASE</varname> stays the same. </para> +</listitem> + <listitem><para><command>cvs import</command> the modified package in the new place.</para></listitem> |