[25281] trunk/base/doc/portfile.7

[source_changes at macosforge.org]

Revision: 25281
          http://trac.macosforge.org/projects/macports/changeset/25281
Author:   jberry at macports.org
Date:     2007-05-16 20:50:53 -0700 (Wed, 16 May 2007)

Log Message:
-----------

 * Add description of variant description specification
 * Remove discussion of workdir variable which is officially deprecated and soon to go away.

Modified Paths:
--------------
    trunk/base/doc/portfile.7

Modified: trunk/base/doc/portfile.7
===================================================================
--- trunk/base/doc/portfile.7	2007-05-17 03:12:48 UTC (rev 25280)
+++ trunk/base/doc/portfile.7	2007-05-17 03:50:53 UTC (rev 25281)
@@ -366,16 +366,7 @@
 .br
 .Sy Type:
 .Em read-only
-.It Ic workdir
-Path to work directory relative to
-.Ic portpath .
-Where possible use
-.Ic workpath
-instead.
 .br
-.Sy Type:
-.Em read-only
-.br
 .Sy Default:
 .Em work
 .It Ic workpath
@@ -385,7 +376,7 @@
 .Em read-only
 .br
 .Sy Default:
-.Em ${portpath}/${workdir}
+.Em ${portbuildpath}/work
 .It Ic worksrcpath
 Full path to working sources (where port has unpacked itself).
 .br
@@ -603,7 +594,7 @@
 .br
 Sets extract.pre_args to: -q
 .br
-Sets extract.post_args to: "-d ${portpath}/${workdir}"
+Sets extract.post_args to: "-d ${workpath}"
 .br
 .Sy Type:
 .Em optional
@@ -1310,6 +1301,7 @@
 .Ic variant
 .Op Cm requires Ar variant
 .Op Cm conflicts Ar variant
+.Op Cm description Ar "description"
 .Xc
 The value is usually a TCL script which modifies other port's
 .Nm
@@ -1317,13 +1309,15 @@
 port can be expressed with
 .Cm requires
 and
-.Cm conflicts .
-The example adds a "gnome" variant to a port.
+.Cm conflicts . 
+.Cm description
+provides a means to supply a description of the variant for the user.
 .br
 .Sy Type:
 .Em optional
 .br
 .Sy Example:
+Add a "gnome" variant to a port.
 .Bd -literal -offset indent -compact
 variant gnome requires glib { configure.args-append --with-gnome \e\
 

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.macosforge.org/pipermail/macports-changes/attachments/20070516/0a9c190a/attachment.html