Skip to content
Permalink
Browse files

Update the documentation to reflect the change with contents { } hand…

…ling.

NOTE: Updating the docs to conform to any behavioral change is a GOOD THING
and everybody doing that kind of work should be consistent about doing this
the very minute their work enters the trunk. :)

git-svn-id: https://svn.macports.org/repository/macports/trunk/doc@1529 d073be05-634f-4543-b044-5fe20cf6d1d6
  • Loading branch information
Jordan K. Hubbard
Jordan K. Hubbard committed Jan 3, 2003
1 parent f2a06d2 commit 14a229bfa66ba3809f400e38500a316ac3e47e5d
Showing with 2 additions and 10 deletions.
  1. +0 −8 guide/xml/details.xml
  2. +1 −1 guide/xml/quick.xml
  3. +1 −1 guide/xml/style.xml
@@ -538,14 +538,6 @@ foo.tar.gz md5 65b89365a65dcad71d4402b44</userinput>
<para><userinput>include contents</userinput>
</para>
<tip>
<para>Escaping a lot of lines in a contents file can be rather irritating, so the list can be wrapped in curly brackets.</para>
<para><programlisting>
contents &lcub;
bin/foo
lib/foolib
man/man1/foo.1.gz
&rcub;
</programlisting></para>
<para>The following is very useful for partly automating the contents list creation process. The snippet assumes you are installing in the default &dollar;&lcub;prefix&rcub; /opt/local. You must only include files that your port should uninstall so leave out directories like bin or share. Also, don't include reciept or Portfile directories under &dollar;&lcub;prefix&rcub;/var/db/dports. </para>
<programlisting>
% find -d /opt/local &gt; /tmp/existing.files
@@ -274,7 +274,7 @@ include contents
<sect2>
<title>Don't quote or wrap items in '{}'.</title>
<para>
Frequently people submit ports with the description or configure arguments quoted, or wrapped in curly brackets. In general this is not correct. The exception is contents lists, which have been specifically designed to handle the list being wrapped in curly brackets because of the very large number of files some ports install make escaping all the newlines extremely irritating.
Frequently people submit ports with the description or configure arguments quoted, or wrapped in curly brackets. In general this is not correct.
</para>
</sect2>
</sect1>
@@ -61,7 +61,7 @@
<sect2>
<title>Contents Lists</title>
<para>
Short contents lists should appear within the port file, listing each file on a single line, using backslashes to continue the list over the line breaks. If the list is long, it is often better to place the contents in another file named something like &ldquo;contents&rdquo; and pull it into the port file with an &ldquo;include&rdquo; statement. In these cases it may also make sense to use &ldquo;&lcub;&rcub;&rdquo; braces to group the file names instead of continuing across lines by escaping newlines, although this breaks the consistancy of symbol usage within the port file. If a variant changes the items installed the variant content file should be named &ldquo;contents-foo&rdquo;, where foo is the name of the variant.
Short contents lists should appear within the port file, listing each file on a single line, using backslashes to continue the list over the line breaks. If the list is long, it is often better to place the contents in another file named something like &ldquo;contents&rdquo; and pull it into the port file with an &ldquo;include&rdquo; statement. If a variant changes the items installed the variant content file should be named &ldquo;contents-foo&rdquo;, where foo is the name of the variant.
</para>
<tip>
<para>

0 comments on commit 14a229b

Please sign in to comment.
You can’t perform that action at this time.