Changeset 1529 for trunk/doc

Timestamp:

Jan 3, 2003, 8:08:02 AM (21 years ago)

Author:

jkh

Message:

Update the documentation to reflect the change with contents { } handling.

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. :)

Location:

trunk/doc/guide/xml

Files:

• details.xml (modified) (1 diff)
• quick.xml (modified) (1 diff)
• style.xml (modified) (1 diff)

trunk/doc/guide/xml/details.xml

@@ -539 +539 @@
                                                 </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>

trunk/doc/guide/xml/quick.xml

@@ -275 +275 @@
                                                 <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>

trunk/doc/guide/xml/style.xml

@@ -62 +62 @@
                         <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>