Update of /cvsroot/fink/web/doc/packaging
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv8516/web/doc/packaging

Modified Files:
        compilers.en.php format.en.php fslayout.en.php index.en.php 
        intro.en.php packaging.en.html policy.en.php reference.en.php 
Log Message:
Clean up some notes about the Revision field.
Clarify some fieldname terminology for %{default_script}
Document BuildConflicts (oops!)
Prohibit common %n as splitoff of multiple parents.


Index: compilers.en.php
===================================================================
RCS file: /cvsroot/fink/web/doc/packaging/compilers.en.php,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -d -r1.8 -r1.9
--- compilers.en.php    26 Jul 2005 08:43:47 -0000      1.8
+++ compilers.en.php    1 Aug 2005 06:32:15 -0000       1.9
@@ -1,7 +1,7 @@
 <?
 $title = "Packaging - Compilers";
 $cvs_author = 'Author: dmacks';
-$cvs_date = 'Date: 2005/07/26 08:38:42';
+$cvs_date = 'Date: 2005/08/01 06:23:58';
 $metatags = '<link rel="contents" href="index.php?phpLang=en" title="Packaging 
Contents"><link rel="next" href="reference.php?phpLang=en" 
title="Reference"><link rel="prev" href="fslayout.php?phpLang=en" 
title="Filesystem Layout">';
 
 

Index: intro.en.php
===================================================================
RCS file: /cvsroot/fink/web/doc/packaging/intro.en.php,v
retrieving revision 1.61
retrieving revision 1.62
diff -u -d -r1.61 -r1.62
--- intro.en.php        26 Jul 2005 08:43:47 -0000      1.61
+++ intro.en.php        1 Aug 2005 06:32:16 -0000       1.62
@@ -1,7 +1,7 @@
 <?
 $title = "Packaging - Intro";
 $cvs_author = 'Author: dmacks';
-$cvs_date = 'Date: 2005/07/26 08:38:42';
+$cvs_date = 'Date: 2005/08/01 06:23:58';
 $metatags = '<link rel="contents" href="index.php?phpLang=en" title="Packaging 
Contents"><link rel="next" href="format.php?phpLang=en" title="Package 
Descriptions"><link rel="prev" href="index.php?phpLang=en" title="Packaging 
Contents">';
 
 
@@ -48,7 +48,7 @@
 A package is identified by three strings: the package name, the
 version and the revision.
 All of these may contain lower-case letters (a-z), numbers (0-9),
-dashes (-), plus signs (+) and dots (.).
+dashes (-; note: not allowed in the revision), plus signs (+) and dots (.).
 Other characters are not allowed.
 In particular, capital letters and underscores are not allowed.
 </p>

Index: format.en.php
===================================================================
RCS file: /cvsroot/fink/web/doc/packaging/format.en.php,v
retrieving revision 1.61
retrieving revision 1.62
diff -u -d -r1.61 -r1.62
--- format.en.php       26 Jul 2005 08:43:47 -0000      1.61
+++ format.en.php       1 Aug 2005 06:32:15 -0000       1.62
@@ -1,7 +1,7 @@
 <?
 $title = "Packaging - Package Descriptions";
 $cvs_author = 'Author: dmacks';
-$cvs_date = 'Date: 2005/07/26 08:38:42';
+$cvs_date = 'Date: 2005/08/01 06:23:58';
 $metatags = '<link rel="contents" href="index.php?phpLang=en" title="Packaging 
Contents"><link rel="next" href="policy.php?phpLang=en" title="Packaging 
Policy"><link rel="prev" href="intro.php?phpLang=en" title="Introduction">';
 
 
@@ -243,10 +243,10 @@
 </p>
 </td></tr><tr valign="top"><td>%{default_script}</td><td>
 <p>
-Valid only in <code>*Script</code> fields, the default contents of
+Valid only in <code>PatchScript</code>, <code>CompileScript</code>, and 
<code>InstallScript</code> fields, the default contents of
 that type of field. The value is often dependent on
 the <code>Type</code> field, and is always defined (though it may be
-blank). When used in a <code>SplitOff: InstallScript</code>, this
+blank). When used in the <code>InstallScript</code> of a <code>SplitOff</code> 
(or <code>SplitOff<b>N</b></code>), this
 expansion will yield the <b>parent's</b> default, even though the
 default for <code>InstallScript</code> in a <code>SplitOff</code>
 package is blank. (Introduced in fink-0.20.6)

Index: policy.en.php
===================================================================
RCS file: /cvsroot/fink/web/doc/packaging/policy.en.php,v
retrieving revision 1.62
retrieving revision 1.63
diff -u -d -r1.62 -r1.63
--- policy.en.php       26 Jul 2005 08:43:47 -0000      1.62
+++ policy.en.php       1 Aug 2005 06:32:16 -0000       1.63
@@ -1,7 +1,7 @@
 <?
 $title = "Packaging - Policy";
 $cvs_author = 'Author: dmacks';
-$cvs_date = 'Date: 2005/07/26 08:38:42';
+$cvs_date = 'Date: 2005/08/01 06:23:58';
 $metatags = '<link rel="contents" href="index.php?phpLang=en" title="Packaging 
Contents"><link rel="next" href="fslayout.php?phpLang=en" title="Filesystem 
Layout"><link rel="prev" href="format.php?phpLang=en" title="Package 
Descriptions">';
 
 

Index: reference.en.php
===================================================================
RCS file: /cvsroot/fink/web/doc/packaging/reference.en.php,v
retrieving revision 1.63
retrieving revision 1.64
diff -u -d -r1.63 -r1.64
--- reference.en.php    26 Jul 2005 08:43:47 -0000      1.63
+++ reference.en.php    1 Aug 2005 06:32:16 -0000       1.64
@@ -1,7 +1,7 @@
 <?
 $title = "Packaging - Reference";
 $cvs_author = 'Author: dmacks';
-$cvs_date = 'Date: 2005/07/26 08:38:42';
+$cvs_date = 'Date: 2005/08/01 06:23:58';
 $metatags = '<link rel="contents" href="index.php?phpLang=en" title="Packaging 
Contents"><link rel="prev" href="compilers.php?phpLang=en" title="Compilers">';
 
 
@@ -119,7 +119,7 @@
   removing, or renaming splitoff packages or shifting files among
   them. When migrating a package to a new tree (from 10.2 to 10.3, for
   example) involves such changes, you should
-  increase <code>Revision</code> by 10 in the newer tree in order to
+  increase <code>Revision</code> by 10 (or some other large number) in the 
newer tree in order to
   leave space for future updates to the package in the older
   tree.
 </p>
@@ -397,6 +397,14 @@
 However, it is passed on to dpkg and will be handled accordingly.
 In summary, it only effects run-time, not build-time.
 </p>
+</td></tr><tr valign="top"><td>BuildConflicts</td><td>
+<p>
+A list of packages that must not be installed while this package is
+being compiled. This can be used to prevent <code>./configure</code>
+or the compiler from seeing undesired library headers or to avoid use
+of a version of a tool that is known to be broken (for example, a bug
+in a certain version of sed).
+</p>
 </td></tr><tr valign="top"><td>Replaces</td><td>
 <p>
 This is used together with "Conflicts", when this package not only
@@ -1204,6 +1212,22 @@
 be modified by declaring the field within the <code>SplitOff</code> or 
<code>SplitOff<b>N</b></code>.</li>
 </ul>
 <p>
+Because %n-%v-%r is treated as the unique identifier of a package, you
+must not have the same <code>Package</code> (at the
+same <code>Version</code> and <code>Revision</code>) listed as
+a <code>SplitOff</code> (or <code>SplitOff<b>N</b></code>) of
+multiple packages. If you use variants, remember that each variant is
+considered an independent package, so the following package layout is
+forbidden:
+</p>
+<pre>
+Package: mime-base64-pm%type_pkg[perl]
+Type: perl (5.8.1 5.8.6)
+SplitOff: %lt;%lt;
+  Package: mime-base64-pm-bin
+%lt;%lt;
+</pre>
+<p>
 During the install phase, the <code>InstallScript</code> and 
 <code>DocFiles</code> of the parent package are executed first.
 Next comes processing of the <code>SplitOff</code> and 
<code>SplitOff<b>N</b></code> fields. For each such field in turn, the 
<code>Files</code> command causes the listed files and directories

Index: fslayout.en.php
===================================================================
RCS file: /cvsroot/fink/web/doc/packaging/fslayout.en.php,v
retrieving revision 1.61
retrieving revision 1.62
diff -u -d -r1.61 -r1.62
--- fslayout.en.php     26 Jul 2005 08:43:47 -0000      1.61
+++ fslayout.en.php     1 Aug 2005 06:32:15 -0000       1.62
@@ -1,7 +1,7 @@
 <?
 $title = "Packaging - FS Layout";
 $cvs_author = 'Author: dmacks';
-$cvs_date = 'Date: 2005/07/26 08:38:42';
+$cvs_date = 'Date: 2005/08/01 06:23:58';
 $metatags = '<link rel="contents" href="index.php?phpLang=en" title="Packaging 
Contents"><link rel="next" href="compilers.php?phpLang=en" 
title="Compilers"><link rel="prev" href="policy.php?phpLang=en" 
title="Packaging Policy">';
 
 

Index: packaging.en.html
===================================================================
RCS file: /cvsroot/fink/web/doc/packaging/packaging.en.html,v
retrieving revision 1.72
retrieving revision 1.73
diff -u -d -r1.72 -r1.73
--- packaging.en.html   26 Jul 2005 08:43:47 -0000      1.72
+++ packaging.en.html   1 Aug 2005 06:32:16 -0000       1.73
@@ -73,7 +73,7 @@
 A package is identified by three strings: the package name, the
 version and the revision.
 All of these may contain lower-case letters (a-z), numbers (0-9),
-dashes (-), plus signs (+) and dots (.).
+dashes (-; note: not allowed in the revision), plus signs (+) and dots (.).
 Other characters are not allowed.
 In particular, capital letters and underscores are not allowed.
 </p>
@@ -329,10 +329,10 @@
 </p>
 </td></tr><tr valign="top"><td>%{default_script}</td><td>
 <p>
-Valid only in <tt style="white-space: nowrap;">*Script</tt> fields, the 
default contents of
+Valid only in <tt style="white-space: nowrap;">PatchScript</tt>, <tt 
style="white-space: nowrap;">CompileScript</tt>, and <tt style="white-space: 
nowrap;">InstallScript</tt> fields, the default contents of
 that type of field. The value is often dependent on
 the <tt style="white-space: nowrap;">Type</tt> field, and is always defined 
(though it may be
-blank). When used in a <tt style="white-space: nowrap;">SplitOff: 
InstallScript</tt>, this
+blank). When used in the <tt style="white-space: nowrap;">InstallScript</tt> 
of a <tt style="white-space: nowrap;">SplitOff</tt> (or <tt style="white-space: 
nowrap;">SplitOff<b>N</b></tt>), this
 expansion will yield the <b>parent's</b> default, even though the
 default for <tt style="white-space: nowrap;">InstallScript</tt> in a <tt 
style="white-space: nowrap;">SplitOff</tt>
 package is blank. (Introduced in fink-0.20.6)
@@ -1396,7 +1396,7 @@
   removing, or renaming splitoff packages or shifting files among
   them. When migrating a package to a new tree (from 10.2 to 10.3, for
   example) involves such changes, you should
-  increase <tt style="white-space: nowrap;">Revision</tt> by 10 in the newer 
tree in order to
+  increase <tt style="white-space: nowrap;">Revision</tt> by 10 (or some other 
large number) in the newer tree in order to
   leave space for future updates to the package in the older
   tree.
 </p>
@@ -1674,6 +1674,14 @@
 However, it is passed on to dpkg and will be handled accordingly.
 In summary, it only effects run-time, not build-time.
 </p>
+</td></tr><tr valign="top"><td>BuildConflicts</td><td>
+<p>
+A list of packages that must not be installed while this package is
+being compiled. This can be used to prevent <tt style="white-space: 
nowrap;">./configure</tt>
+or the compiler from seeing undesired library headers or to avoid use
+of a version of a tool that is known to be broken (for example, a bug
+in a certain version of sed).
+</p>
 </td></tr><tr valign="top"><td>Replaces</td><td>
 <p>
 This is used together with "Conflicts", when this package not only
@@ -2481,6 +2489,22 @@
 be modified by declaring the field within the <tt style="white-space: 
nowrap;">SplitOff</tt> or <tt style="white-space: 
nowrap;">SplitOff<b>N</b></tt>.</li>
 </ul>
 <p>
+Because %n-%v-%r is treated as the unique identifier of a package, you
+must not have the same <tt style="white-space: nowrap;">Package</tt> (at the
+same <tt style="white-space: nowrap;">Version</tt> and <tt style="white-space: 
nowrap;">Revision</tt>) listed as
+a <tt style="white-space: nowrap;">SplitOff</tt> (or <tt style="white-space: 
nowrap;">SplitOff<b>N</b></tt>) of
+multiple packages. If you use variants, remember that each variant is
+considered an independent package, so the following package layout is
+forbidden:
+</p>
+<pre>
+Package: mime-base64-pm%type_pkg[perl]
+Type: perl (5.8.1 5.8.6)
+SplitOff: %lt;%lt;
+  Package: mime-base64-pm-bin
+%lt;%lt;
+</pre>
+<p>
 During the install phase, the <tt style="white-space: 
nowrap;">InstallScript</tt> and 
 <tt style="white-space: nowrap;">DocFiles</tt> of the parent package are 
executed first.
 Next comes processing of the <tt style="white-space: nowrap;">SplitOff</tt> 
and <tt style="white-space: nowrap;">SplitOff<b>N</b></tt> fields. For each 
such field in turn, the <tt style="white-space: nowrap;">Files</tt> command 
causes the listed files and directories
@@ -2599,4 +2623,4 @@
 provided the document and this copyright notice remain complete and
 unmodified. Any commercial reproduction and any online publication
 requires the explicit consent of the author.</p><hr>
-<p>Generated from <i>$Fink: packaging.en.xml,v 1.74 2005/07/26 08:38:42 dmacks 
Exp $</i></p></body></html>
+<p>Generated from <i>$Fink: packaging.en.xml,v 1.78 2005/08/01 06:23:58 dmacks 
Exp $</i></p></body></html>

Index: index.en.php
===================================================================
RCS file: /cvsroot/fink/web/doc/packaging/index.en.php,v
retrieving revision 1.62
retrieving revision 1.63
diff -u -d -r1.62 -r1.63
--- index.en.php        26 Jul 2005 08:43:47 -0000      1.62
+++ index.en.php        1 Aug 2005 06:32:15 -0000       1.63
@@ -1,7 +1,7 @@
 <?
 $title = "Packaging";
 $cvs_author = 'Author: dmacks';
-$cvs_date = 'Date: 2005/07/26 08:38:42';
+$cvs_date = 'Date: 2005/08/01 06:23:58';
 $metatags = '<link rel="contents" href="index.php?phpLang=en" title="Packaging 
Contents"><link rel="next" href="intro.php?phpLang=en" title="Introduction">';
 
 
@@ -30,7 +30,7 @@
 </p>
 <h2><? echo FINK_CONTENTS ; ?></h2><ul>
        <li><a href="intro.php?phpLang=en"><b>1 Introduction</b></a><ul><li><a 
href="intro.php?phpLang=en#def1">1.1 What is a Package?</a></li><li><a 
href="intro.php?phpLang=en#ident">1.2 Identifying a 
Package</a></li></ul></li><li><a href="format.php?phpLang=en"><b>2 Package 
Descriptions</b></a><ul><li><a href="format.php?phpLang=en#trees">2.1 Tree 
Layout</a></li><li><a href="format.php?phpLang=en#format">2.2 File 
Format</a></li><li><a href="format.php?phpLang=en#percent">2.3 Percent 
Expansion</a></li></ul></li><li><a href="policy.php?phpLang=en"><b>3 Packaging 
Policy</b></a><ul><li><a href="policy.php?phpLang=en#licenses">3.1 Package 
Licenses</a></li><li><a href="policy.php?phpLang=en#openssl">3.2 The GPL and 
OpenSSL</a></li><li><a href="policy.php?phpLang=en#prefix">3.3 Base System 
Interference</a></li><li><a href="policy.php?phpLang=en#sharedlibs">3.4 Shared 
Libraries</a></li><li><a href="policy.php?phpLang=en#perlmods">3.5 Perl 
Modules</a></li><li><a href="policy.php?phpLang=e
 n#emacs">3.6 Emacs Policy</a></li></ul></li><li><a 
href="fslayout.php?phpLang=en"><b>4 Filesystem Layout</b></a><ul><li><a 
href="fslayout.php?phpLang=en#fhs">4.1 The Filesystem Hierarchy 
Standard</a></li><li><a href="fslayout.php?phpLang=en#dirs">4.2 The 
Directories</a></li><li><a href="fslayout.php?phpLang=en#avoid">4.3 Things to 
Avoid</a></li></ul></li><li><a href="compilers.php?phpLang=en"><b>5 
Compilers</b></a><ul><li><a href="compilers.php?phpLang=en#versions">5.1 
Compiler Versions</a></li><li><a href="compilers.php?phpLang=en#abi">5.2 The 
g++ ABI</a></li></ul></li><li><a href="reference.php?phpLang=en"><b>6 
Reference</b></a><ul><li><a href="reference.php?phpLang=en#build">6.1 The Build 
Process</a></li><li><a href="reference.php?phpLang=en#fields">6.2 
Fields</a></li><li><a href="reference.php?phpLang=en#splitoffs">6.3 
SplitOffs</a></li><li><a href="reference.php?phpLang=en#scripts">6.4 
Scripts</a></li><li><a href="reference.php?phpLang=en#patches">6.5 
Patches</a></li><l
 i><a href="reference.php?phpLang=en#profile.d">6.6 Profile.d 
scripts</a></li></ul></li></ul>
-<!--Generated from $Fink: packaging.en.xml,v 1.74 2005/07/26 08:38:42 dmacks 
Exp $-->
+<!--Generated from $Fink: packaging.en.xml,v 1.78 2005/08/01 06:23:58 dmacks 
Exp $-->
 <? include_once "../../footer.inc"; ?>
 
 



-------------------------------------------------------
SF.Net email is sponsored by: Discover Easy Linux Migration Strategies
from IBM. Find simple to follow Roadmaps, straightforward articles,
informative Webcasts and more! Get everything you need to get up to
speed, fast. http://ads.osdn.com/?ad_id=7477&alloc_id=16492&op=click
_______________________________________________
Fink-commits mailing list
Fink-commits@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/fink-commits

Reply via email to