[107096] trunk/base/doc/archive_sites.conf

[larryv at macports.org]

Revision: 107096
          https://trac.macports.org/changeset/107096
Author:   larryv at macports.org
Date:     2013-06-17 21:18:25 -0700 (Mon, 17 Jun 2013)
Log Message:
-----------
archive_sites.conf: Rewrite and expand comments.

Also remove the suggested method of disabling the default archive
sources, which doesn't seem to work (#39455).

Modified Paths:
--------------
    trunk/base/doc/archive_sites.conf

Modified: trunk/base/doc/archive_sites.conf
===================================================================
--- trunk/base/doc/archive_sites.conf	2013-06-18 03:43:24 UTC (rev 107095)
+++ trunk/base/doc/archive_sites.conf	2013-06-18 04:18:25 UTC (rev 107096)
@@ -1,27 +1,40 @@
-# Configuration for (binary) archive sources.
 # $Id$
 
-# Each entry is started by a name line. The only required values are name and
-# urls. Other fields are type, prefix, applications_dir and frameworks_dir,
-# which have the usual default values:
-#    type tbz2
-#    prefix /opt/local
-#    applications_dir /Applications/MacPorts
-#    frameworks_dir ${prefix}/Library/Frameworks
+# MacPorts configuration file for binary archive sources.
+
+# Each source entry consists of one or more fields.
 #
-# type can be any of: tgz, tar, tbz, tbz2, tlz, txz, xar, zip, cpgz, cpio
-# Note that some types require a corresponding tool to be installed, and
-# entries with an unsupported type will not be used.
+#   name: A name for the archive source. This field always starts a new
+#       entry. Required.
+#
+#   urls: A whitespace-delimited list of the source's URLs. Defaults to
+#       an empty list.
+#
+#   type: The filetype of the archives; valid values are "cpgz", "cpio",
+#       "tar", "tbz", "tbz2", "tgz", "tlz", "txz", "xar", and "zip".
+#       MacPorts handles each archive type with an appropriate external
+#       executable; if it cannot find such an executable, or if the
+#       specified type is invalid, the source is not used. Defaults to
+#       "tbz2".
+#
+#   prefix: The prefix of the MacPorts installation used to create the
+#       source's archives. This must match the value of "prefix" set in
+#       macports.conf, or the source is not used. Defaults to
+#       "/opt/local".
+#
+#   applications_dir: The applications directory of the MacPorts
+#       installation used to create the source's archives. This must
+#       match the value of "applications_dir" set in macports.conf, or
+#       the source is not used. Defaults to "/Applications/MacPorts".
+#
+#   frameworks_dir: The frameworks directory of the MacPorts
+#       installation used to create the source's archives. This must
+#       match the value of "frameworks_dir" set in macports.conf, or the
+#       source is not used. Defaults to "[prefix]/Library/Frameworks".
 
-# Example:
-#name                mysource
-#urls                http://example.com/ ftp://ftp.example.org/
-#type                tbz2
+# Example source:
+#name                My Source
+#urls                http://example.com/ ftp://ftp.example.com/packages/
+#type                zip
 #prefix              /opt/mysource
 #applications_dir    /opt/mysource/Applications
-#frameworks_dir      /opt/mysource/Library/Frameworks
-
-# If you want to disable use of the archive sites listed in the ports tree,
-# you could do this:
-#name                macports_archives
-#urls
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/macports-changes/attachments/20130617/2c600833/attachment-0001.html>