[29335] trunk/doc-new/guide/xml
source_changes at macosforge.org
source_changes at macosforge.org
Fri Sep 21 05:30:40 PDT 2007
Revision: 29335
http://trac.macosforge.org/projects/macports/changeset/29335
Author: simon at macports.org
Date: 2007-09-21 05:30:39 -0700 (Fri, 21 Sep 2007)
Log Message:
-----------
Undoing accidentally committed changes to the new documentation in r29303.
Modified Paths:
--------------
trunk/doc-new/guide/xml/guide.xml
trunk/doc-new/guide/xml/portfiledev.xml
trunk/doc-new/guide/xml/portfileref.xml
trunk/doc-new/guide/xml/using.xml
Modified: trunk/doc-new/guide/xml/guide.xml
===================================================================
--- trunk/doc-new/guide/xml/guide.xml 2007-09-21 09:57:04 UTC (rev 29334)
+++ trunk/doc-new/guide/xml/guide.xml 2007-09-21 12:30:39 UTC (rev 29335)
@@ -59,4 +59,6 @@
<xi:include href="internals.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="project.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-</book>
\ No newline at end of file
+
+ <xi:include href="glossary.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</book>
Modified: trunk/doc-new/guide/xml/portfiledev.xml
===================================================================
--- trunk/doc-new/guide/xml/portfiledev.xml 2007-09-21 09:57:04 UTC (rev 29334)
+++ trunk/doc-new/guide/xml/portfiledev.xml 2007-09-21 12:30:39 UTC (rev 29335)
@@ -66,8 +66,8 @@
install</command> steps, which conform to phases configure, build, and
destroot respectively. For applications that do not conform to this
standard behavior, any installation phase may be augmented using <link
- linkend="development.examples.pre-post">pre- and/or post- phases</link>,
- or even <link linkend="development.examples.override">overridden</link> or
+ linkend="development.examples.augment">pre- and/or post- phases</link>, or
+ even <link linkend="development.examples.override">overridden</link> or
<link linkend="development.examples.eliminate">eliminated</link>. See
<link linkend="development.examples">Example Portfiles</link>
below.</para>
@@ -514,8 +514,8 @@
<listitem>
<para>Now use the Unix command <command>diff -u </command>to create
- a "unified" diff patch file. Name the patchfile
- appropriately.</para>
+ a "unified" diff patch file. Put the name of the port in the
+ patchfile, for example, Portfile-rrdtool.diff.</para>
<programlisting><prompt>%%</prompt> <userinput>diff -u Portfile.orig Portfile > Portfile-rrdtool.diff</userinput></programlisting>
</listitem>
@@ -615,9 +615,18 @@
<para>Now you may place the patch
<filename>patch-Makefile.in</filename> in the path ${portpath}/files
of a local repository (or commit it to subversion) and use it in a
- port using the patchfiles keyword.</para>
+ port using the <code>patchfiles</code> keyword.</para>
<programlisting>patchfiles patch-Makefile.in</programlisting>
+
+ <note>
+ <para>You should make a patch file for each file to be patched,
+ though if you obtain a patch from another source that patches
+ multiple files it is permissible to use it that way. Patch
+ filenames should generally be of the form
+ "patch-<directory>-<filename>", as shown in this
+ example: <filename>patch-src-Makefile.in</filename>.</para>
+ </note>
</listitem>
</orderedlist>
</section>
@@ -626,8 +635,9 @@
<title>Manually Applying Patches</title>
<para>Though MacPorts applies patch files automatically, you may want to
- know how to apply patch files manually if you want to apply uncommitted
- Portfile patches or other similar uses.</para>
+ know how to apply patch files manually if you want to test patch files
+ you have created or you wish to apply uncommitted Portfile
+ patches.</para>
<orderedlist>
<listitem>
@@ -642,7 +652,7 @@
<para>Now apply the patch that is on the current user's desktop. The
patchfile knows the filename of the file to be patched.</para>
- <programlisting><prompt>%%</prompt> <userinput>patch < ~/Desktop/Portfile.diff</userinput></programlisting>
+ <programlisting><prompt>%%</prompt> <userinput>patch -p0 < ~/Desktop/Portfile-postfix.diff</userinput></programlisting>
<screen>patching file Portfile</screen>
</listitem>
@@ -660,19 +670,27 @@
<section id="development.practices.dont-overwrite">
<title>Don't Overwrite Config Files</title>
- <para></para>
+ <para>TODO:</para>
</section>
<section id="development.practices.install-docs">
<title>Install Docs and Examples</title>
- <para></para>
+ <para>TODO:</para>
</section>
<section id="development.practices.provide-messages">
<title>Provide User Messages</title>
- <para></para>
+ <para>TODO:</para>
</section>
+
+ <section id="development.practices.use-variables">
+ <title>Use Variables</title>
+
+ <para>TODO: Set variables so changing paths may be done in one place;
+ use them anytime it makes updates simpler: distname
+ ${name}-src-${version}</para>
+ </section>
</section>
</chapter>
\ No newline at end of file
Modified: trunk/doc-new/guide/xml/portfileref.xml
===================================================================
--- trunk/doc-new/guide/xml/portfileref.xml 2007-09-21 09:57:04 UTC (rev 29334)
+++ trunk/doc-new/guide/xml/portfileref.xml 2007-09-21 12:30:39 UTC (rev 29335)
@@ -16,7 +16,7 @@
<command>configure</command>, <command>make</command>, and <command>make
install</command> steps, but for applications that do not conform to this
behavior, installation phases may be declared in a Portfile to <link
- linkend="development.examples.pre-post">augment</link> or <link
+ linkend="development.examples.augment">augment</link> or <link
linkend="development.examples.override">override</link> the default
behavior as described in the <link linkend="development">Portfile
Development</link> chapter.</para>
Modified: trunk/doc-new/guide/xml/using.xml
===================================================================
--- trunk/doc-new/guide/xml/using.xml 2007-09-21 09:57:04 UTC (rev 29334)
+++ trunk/doc-new/guide/xml/using.xml 2007-09-21 12:30:39 UTC (rev 29335)
@@ -42,7 +42,7 @@
<screen>DEBUG: Rebuilding the MacPorts base system if needed.
DEBUG: Synchronizing ports tree(s)
Synchronizing from rsync://rsync.macports.org/release/ports/
-DEBUG: /usr/bin/rsync -rtzv rsync://rsync.macports.org/release/ports/
+DEBUG: /usr/bin/rsync -rtzv --delete-after rsync://rsync.macports.org/release/ports/
receiving file list ... done
[ ... trimmed ... ]
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.macosforge.org/pipermail/macports-changes/attachments/20070921/04548daa/attachment.html
More information about the macports-changes
mailing list