Update of /cvsroot/fink/web/doc/packaging
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv18097/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:
Document PatchFile and related fields.
Index: fslayout.en.php
===================================================================
RCS file: /cvsroot/fink/web/doc/packaging/fslayout.en.php,v
retrieving revision 1.69
retrieving revision 1.70
diff -u -d -r1.69 -r1.70
--- fslayout.en.php 9 Feb 2006 02:27:38 -0000 1.69
+++ fslayout.en.php 22 Feb 2006 06:33:11 -0000 1.70
@@ -1,7 +1,7 @@
<?
$title = "Packaging - FS Layout";
$cvs_author = 'Author: dmacks';
-$cvs_date = 'Date: 2006/02/09 02:26:39';
+$cvs_date = 'Date: 2006/02/22 06:31:55';
$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: intro.en.php
===================================================================
RCS file: /cvsroot/fink/web/doc/packaging/intro.en.php,v
retrieving revision 1.69
retrieving revision 1.70
diff -u -d -r1.69 -r1.70
--- intro.en.php 9 Feb 2006 02:27:38 -0000 1.69
+++ intro.en.php 22 Feb 2006 06:33:11 -0000 1.70
@@ -1,7 +1,7 @@
<?
$title = "Packaging - Intro";
$cvs_author = 'Author: dmacks';
-$cvs_date = 'Date: 2006/02/09 02:26:39';
+$cvs_date = 'Date: 2006/02/22 06:31:55';
$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">';
Index: format.en.php
===================================================================
RCS file: /cvsroot/fink/web/doc/packaging/format.en.php,v
retrieving revision 1.70
retrieving revision 1.71
diff -u -d -r1.70 -r1.71
--- format.en.php 9 Feb 2006 02:27:38 -0000 1.70
+++ format.en.php 22 Feb 2006 06:33:11 -0000 1.71
@@ -1,7 +1,7 @@
<?
$title = "Packaging - Package Descriptions";
$cvs_author = 'Author: dmacks';
-$cvs_date = 'Date: 2006/02/09 02:26:39';
+$cvs_date = 'Date: 2006/02/22 06:31:55';
$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">';
@@ -253,6 +253,11 @@
default for <code>InstallScript</code> in a <code>SplitOff</code>
package is blank. (Introduced in fink-0.20.6)
</p>
+</td></tr><tr valign="top"><td>%{PatchFile}</td><td>
+<p>
+The full path to the file given in the <code>PatchFile</code> field.
+(Introduced in fink-0.24.12)
+</p>
</td></tr></table>
Index: policy.en.php
===================================================================
RCS file: /cvsroot/fink/web/doc/packaging/policy.en.php,v
retrieving revision 1.70
retrieving revision 1.71
diff -u -d -r1.70 -r1.71
--- policy.en.php 9 Feb 2006 02:27:38 -0000 1.70
+++ policy.en.php 22 Feb 2006 06:33:11 -0000 1.71
@@ -1,7 +1,7 @@
<?
$title = "Packaging - Policy";
$cvs_author = 'Author: dmacks';
-$cvs_date = 'Date: 2006/02/09 02:26:39';
+$cvs_date = 'Date: 2006/02/22 06:31:55';
$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: compilers.en.php
===================================================================
RCS file: /cvsroot/fink/web/doc/packaging/compilers.en.php,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -d -r1.16 -r1.17
--- compilers.en.php 9 Feb 2006 02:27:38 -0000 1.16
+++ compilers.en.php 22 Feb 2006 06:33:11 -0000 1.17
@@ -1,7 +1,7 @@
<?
$title = "Packaging - Compilers";
$cvs_author = 'Author: dmacks';
-$cvs_date = 'Date: 2006/02/09 02:26:39';
+$cvs_date = 'Date: 2006/02/22 06:31:55';
$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: reference.en.php
===================================================================
RCS file: /cvsroot/fink/web/doc/packaging/reference.en.php,v
retrieving revision 1.72
retrieving revision 1.73
diff -u -d -r1.72 -r1.73
--- reference.en.php 9 Feb 2006 02:27:38 -0000 1.72
+++ reference.en.php 22 Feb 2006 06:33:11 -0000 1.73
@@ -1,7 +1,7 @@
<?
$title = "Packaging - Reference";
$cvs_author = 'Author: dmacks';
-$cvs_date = 'Date: 2006/02/09 02:26:39';
+$cvs_date = 'Date: 2006/02/22 06:31:55';
$metatags = '<link rel="contents" href="index.php?phpLang=en" title="Packaging
Contents"><link rel="prev" href="compilers.php?phpLang=en" title="Compilers">';
@@ -759,10 +759,11 @@
<p>
The filename of a patch to be applied with <code>patch -p1
<<b>patch-file</b></code>. This should be just a filename; the
-appropriate path will be prepended automatically. Percent expansion is
+appropriate path (the same directory where the <code>.info</code> file
+is located) will be prepended automatically. Percent expansion is
performed on this field, so a typical value is simply
<code>%f.patch</code> or <code>%n.patch</code>. The patch is applied
-before the PatchScript is run (if any).
+in a separate step before the PatchScript is run (if any).
</p>
<p>
Remember that %n includes all %type_ variant data, so you may want to
@@ -771,13 +772,45 @@
changes in <code>PatchScript</code> than to have a separate patchfile
for each variant.
</p>
+</td></tr><tr valign="top"><td>PatchFile</td><td>
+<p>
+The same syntax as the <code>Patch</code> field. The full path to this
+file is available using the <code>%{PatchFile}</code> percent
+expansion--do not use <code>%a</code> to access this file.
+Unlike <code>Patch</code>, <code>PatchFile</code> is applied as part
+of <code>PatchScript</code>. Fink checks that the listed file exists,
+is readable, and that its checksum matches
+the <code>PatchFile-MD5</code> field.
+</p>
+<p>
+You may not use both <code>Patch</code> and <code>PatchFile</code> in
+the same package description. Any package that
+uses <code>PatchFile</code> must declare at least
+<code>BuildDepends: fink (>= 0.24.12)</code>. Giving a higher version
+requirement is allowed if it is necessary for other reasons.
+</p>
+</td></tr><tr valign="top"><td>PatchFile-MD5</td><td>
+<p>
+The MD5 checksum of the file given in the <code>PatchFile</code>
+field. This field is required if <code>PatchFile</code> is used.
+(Introduced in fink-0.24.12)
+</p>
</td></tr><tr valign="top"><td>PatchScript</td><td>
<p>
A list of commands that are run in the patch phase. This is the place
to put commands that patch or otherwise modify the package source. See
the <a href="reference.php?phpLang=en#scripts">note on scripts</a>
-below. Before the commands are executed, <a
href="format.php?phpLang=en#percent">percent expansion</a> takes place. There
is no
-default.
+below. Before the commands are executed, <a
href="format.php?phpLang=en#percent">percent expansion</a> takes place. If
+a <code>PatchFile</code> field exists, the
+default <code>PatchScript</code> is:
+</p>
+<pre>
+patch -p1 < %{PatchFile}
+</pre>
+<p>
+If there is no <code>PatchFile</code>, the default is blank. If you
+have an explicit <code>PatchScript</code>, you must apply
+the <code>PatchFile</code> explicitly.
</p>
</td></tr></table>
<p><b>Compile Phase:</b></p>
@@ -1373,7 +1406,13 @@
<p>If you use the newer simple package filename convention, use %n
insead of %f. These two fields are not mutually-exclusive - you can
use both, and they will both be executed. In that case the PatchScript
-is executed last.</p>
+is executed last. Alternately, you can use the
+newer <code>PatchFile</code> instead of <code>Patch</code> and apply
+with an implicit or explicit <code>PatchScript</code>--see the
+descriptions of the <code>PatchFile</code>
+and <code>PatchScript</code> fields for more information.</p>
+
+
<p>Because you may need to have the users chosen prefix in the patch file
it is recommended that you have a variable such as <code>@PREFIX@</code>
instead of <code>/sw</code> in the patch and then use:</p>
Index: packaging.en.html
===================================================================
RCS file: /cvsroot/fink/web/doc/packaging/packaging.en.html,v
retrieving revision 1.82
retrieving revision 1.83
diff -u -d -r1.82 -r1.83
--- packaging.en.html 9 Feb 2006 02:27:38 -0000 1.82
+++ packaging.en.html 22 Feb 2006 06:33:11 -0000 1.83
@@ -339,6 +339,11 @@
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)
</p>
+</td></tr><tr valign="top"><td>%{PatchFile}</td><td>
+<p>
+The full path to the file given in the <tt style="white-space:
nowrap;">PatchFile</tt> field.
+(Introduced in fink-0.24.12)
+</p>
</td></tr></table>
@@ -2038,10 +2043,11 @@
<p>
The filename of a patch to be applied with <tt style="white-space:
nowrap;">patch -p1
<<b>patch-file</b></tt>. This should be just a filename; the
-appropriate path will be prepended automatically. Percent expansion is
+appropriate path (the same directory where the <tt style="white-space:
nowrap;">.info</tt> file
+is located) will be prepended automatically. Percent expansion is
performed on this field, so a typical value is simply
<tt style="white-space: nowrap;">%f.patch</tt> or <tt style="white-space:
nowrap;">%n.patch</tt>. The patch is applied
-before the PatchScript is run (if any).
+in a separate step before the PatchScript is run (if any).
</p>
<p>
Remember that %n includes all %type_ variant data, so you may want to
@@ -2050,13 +2056,45 @@
changes in <tt style="white-space: nowrap;">PatchScript</tt> than to have a
separate patchfile
for each variant.
</p>
+</td></tr><tr valign="top"><td>PatchFile</td><td>
+<p>
+The same syntax as the <tt style="white-space: nowrap;">Patch</tt> field. The
full path to this
+file is available using the <tt style="white-space: nowrap;">%{PatchFile}</tt>
percent
+expansion--do not use <tt style="white-space: nowrap;">%a</tt> to access this
file.
+Unlike <tt style="white-space: nowrap;">Patch</tt>, <tt style="white-space:
nowrap;">PatchFile</tt> is applied as part
+of <tt style="white-space: nowrap;">PatchScript</tt>. Fink checks that the
listed file exists,
+is readable, and that its checksum matches
+the <tt style="white-space: nowrap;">PatchFile-MD5</tt> field.
+</p>
+<p>
+You may not use both <tt style="white-space: nowrap;">Patch</tt> and <tt
style="white-space: nowrap;">PatchFile</tt> in
+the same package description. Any package that
+uses <tt style="white-space: nowrap;">PatchFile</tt> must declare at least
+<tt style="white-space: nowrap;">BuildDepends: fink (>= 0.24.12)</tt>.
Giving a higher version
+requirement is allowed if it is necessary for other reasons.
+</p>
+</td></tr><tr valign="top"><td>PatchFile-MD5</td><td>
+<p>
+The MD5 checksum of the file given in the <tt style="white-space:
nowrap;">PatchFile</tt>
+field. This field is required if <tt style="white-space:
nowrap;">PatchFile</tt> is used.
+(Introduced in fink-0.24.12)
+</p>
</td></tr><tr valign="top"><td>PatchScript</td><td>
<p>
A list of commands that are run in the patch phase. This is the place
to put commands that patch or otherwise modify the package source. See
the <a href="#reference.scripts">note on scripts</a>
-below. Before the commands are executed, <a href="#format.percent">percent
expansion</a> takes place. There is no
-default.
+below. Before the commands are executed, <a href="#format.percent">percent
expansion</a> takes place. If
+a <tt style="white-space: nowrap;">PatchFile</tt> field exists, the
+default <tt style="white-space: nowrap;">PatchScript</tt> is:
+</p>
+<pre>
+patch -p1 < %{PatchFile}
+</pre>
+<p>
+If there is no <tt style="white-space: nowrap;">PatchFile</tt>, the default is
blank. If you
+have an explicit <tt style="white-space: nowrap;">PatchScript</tt>, you must
apply
+the <tt style="white-space: nowrap;">PatchFile</tt> explicitly.
</p>
</td></tr></table>
<p><b>Compile Phase:</b></p>
@@ -2652,7 +2690,13 @@
<p>If you use the newer simple package filename convention, use %n
insead of %f. These two fields are not mutually-exclusive - you can
use both, and they will both be executed. In that case the PatchScript
-is executed last.</p>
+is executed last. Alternately, you can use the
+newer <tt style="white-space: nowrap;">PatchFile</tt> instead of <tt
style="white-space: nowrap;">Patch</tt> and apply
+with an implicit or explicit <tt style="white-space:
nowrap;">PatchScript</tt>--see the
+descriptions of the <tt style="white-space: nowrap;">PatchFile</tt>
+and <tt style="white-space: nowrap;">PatchScript</tt> fields for more
information.</p>
+
+
<p>Because you may need to have the users chosen prefix in the patch file
it is recommended that you have a variable such as <tt style="white-space:
nowrap;">@PREFIX@</tt>
instead of <tt style="white-space: nowrap;">/sw</tt> in the patch and then
use:</p>
@@ -2689,4 +2733,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.86 2006/02/09 02:26:39 dmacks
Exp $</i></p></body></html>
+<p>Generated from <i>$Fink: packaging.en.xml,v 1.87 2006/02/22 06:31:55 dmacks
Exp $</i></p></body></html>
Index: index.en.php
===================================================================
RCS file: /cvsroot/fink/web/doc/packaging/index.en.php,v
retrieving revision 1.70
retrieving revision 1.71
diff -u -d -r1.70 -r1.71
--- index.en.php 9 Feb 2006 02:27:38 -0000 1.70
+++ index.en.php 22 Feb 2006 06:33:11 -0000 1.71
@@ -1,7 +1,7 @@
<?
$title = "Packaging";
$cvs_author = 'Author: dmacks';
-$cvs_date = 'Date: 2006/02/09 02:26:39';
+$cvs_date = 'Date: 2006/02/22 06:31:55';
$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.86 2006/02/09 02:26:39 dmacks
Exp $-->
+<!--Generated from $Fink: packaging.en.xml,v 1.87 2006/02/22 06:31:55 dmacks
Exp $-->
<? include_once "../../footer.inc"; ?>
-------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc. Do you grep through log files
for problems? Stop! Download the new AJAX search engine that makes
searching your log files as easy as surfing the web. DOWNLOAD SPLUNK!
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=103432&bid=230486&dat=121642
_______________________________________________
Fink-commits mailing list
Fink-commits@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/fink-commits
