[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

pkgsrc/doc/guide/files/submit.xml: 1.19 -> 1.20



以下のページの更新をしました。ツッコミをお願いします。

pkgsrc/doc/guide/files/submit.xml: 1.19 -> 1.20
> revision 1.20
> date: 2009/05/02 16:14:37;  author: reed;  state: Exp;  lines: +42 -1
> 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.

火曜日までに異議がなければ、 commit します。

更新後の訳の全文は
  http://www.na.rim.or.jp/%7Ekano/tmp/docs/pkgsrc/submit.xml
  http://www.na.rim.or.jp/%7Ekano/tmp/docs/pkgsrc/submit.html
に置いてあります。

以下、訳と原文それぞれの新旧の差分です。

--- submit.xml.orig	2009-05-18 01:23:34.000000000 +0900
+++ submit.xml	2009-05-18 01:23:34.000000000 +0900
@@ -1,6 +1,6 @@
-<!-- $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 $ -->
 <!-- Based on english version: -->
-<!-- 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>提出およびコミット</title>
@@ -146,9 +146,36 @@
   もしれません)よりも安定性のほうが好ましいことを念頭に置いてください。</para>
 </sect1>
 
+<sect1 id="renaming-package">
+<title>pkgsrc のパッケージの名前を変更する</title>
+
+<para>パッケージ名の変更は、なるべくしないようにしてください。</para>
+
+
+<para>パッケージ名を変更する際には、かならず、
+  他の Makefile やオプションや buildlink などで古い名前を参照している箇所をすべて修正します。</para>
+
+<para>パッケージ名を変更する際には、さらに、
+  <varname>SUPERSEDES</varname> を旧パッケージのパッケージ名と
+  dewey 式のバージョン番号に設定します。
+  名前が複数回変わっている場合は、複数並べて設定することができます。
+  これで、新しいパッケージで旧名のパッケージを置き換える作業は完了です。
+</para>
+
+<para>なお、CHANGES-<replaceable>YYYY</replaceable> ファイルにおける
+  <quote>successor</quote> の記述は、必ずしも、<emphasis>supersedes</emphasis>
+  の意味ではありません。successor は、厳密な同等品でなくても、
+  代替として使えるものを助言するものでもいいからです。</para>
+
+</sect1>
+
 <sect1 id="moving-package">
 <title>pkgsrcのパッケージを移動する</title>
 
+<para>パッケージの名前の変更や移動は、しないほうがよいのですが、
+  それでも必要な場合は、以下の手順でおこないます。
+</para>
+
 <orderedlist>
 <listitem><para>パッケージのディレクトリーをどこかにコピーします。</para></listitem>
 
@@ -161,6 +188,21 @@
 <quote>../package</quote>とすることができる<varname>DEPENDS</varname>のパスをすべて修正します。</para>
 </listitem>
 
+<listitem><para>修正後のパッケージの Makefile で、
+<varname>PREV_PKGPATH</varname> を、移動前のカテゴリー/パッケージのパス名に設定します。
+この <varname>PREV_PKGPATH</varname> は、
+パッケージの更新を pkgsrc の構築によっておこなうツールが使います。
+たとえば、そういったツールは &man.pkg.summary.5; データベースから
+(<varname>SUPERSEDES</varname> がない場合)
+<varname>PREV_PKGPATH</varname> を検索して、これをもとにパッケージの移動後の
+<varname>PKGPATH</varname> を調べることができます。
+なお、この検索で複数のパスが見つかることもありえるので、
+ツールの側では <varname>PKGBASE</varname> もあわせて検査します。
+この <varname>PREV_PKGPATH</varname> の値を設定するのは、
+<varname>SUPERSEDES</varname> が設定されない場合
+(つまり、<varname>PKGBASE</varname> が変わらない場合) です。  </para>
+</listitem>
+
 <listitem><para>新しい場所で、修正後のパッケージを<command>cvs import</command>
 します。</para></listitem>
 
Index: submit.xml
===================================================================
RCS file: /cvsroot/pkgsrc/doc/guide/files/submit.xml,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -r1.19 -r1.20
--- submit.xml	15 Aug 2007 06:33:46 -0000	1.19
+++ submit.xml	2 May 2009 16:14:37 -0000	1.20
@@ -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>