[62610] trunk/base/doc

[blb at macports.org]

Revision: 62610
          http://trac.macports.org/changeset/62610
Author:   blb at macports.org
Date:     2010-01-11 21:16:09 -0800 (Mon, 11 Jan 2010)
Log Message:
-----------
port and portfile man pages: document the notes variable and command

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

Modified: trunk/base/doc/port.1
===================================================================
--- trunk/base/doc/port.1	2010-01-12 03:54:27 UTC (rev 62609)
+++ trunk/base/doc/port.1	2010-01-12 05:16:09 UTC (rev 62610)
@@ -282,6 +282,10 @@
 .Dl "port info --line --category --name all"
 .Dl "port info --pretty --fullname --depends gtk2"
 .Dl "port info --index python24"
+.Ss notes
+Displays notes for 
+.Ar portname
+(useful information concerning setup and use of the port).
 .Ss variants
 Lists the build variants available for
 .Ar portname .

Modified: trunk/base/doc/portfile.7
===================================================================
--- trunk/base/doc/portfile.7	2010-01-12 03:54:27 UTC (rev 62609)
+++ trunk/base/doc/portfile.7	2010-01-12 05:16:09 UTC (rev 62610)
@@ -129,6 +129,37 @@
 
     painting, processing, and rendering tools.
 .Ed
+.It Ic notes
+Notes for setup and use of the port.  This is shown after the port is
+activated and anytime the
+.Ic notes
+command is used; for example:
+.Pp
+.Dl "port notes python26"
+.Pp
+The advantage to using
+.Ic notes
+instead of
+.Ic ui_msg
+is that it can be queried after a port is installed but
+.Ic ui_msg
+is only printed during an install.  Therefore
+.Ic notes
+is good for any information which may be needed anytime after an install.
+.br
+.Sy Type:
+.Em optional
+.br
+.Sy Example:
+.Bd -literal -offset indent -compact
+notes To fully complete your installation and make python \e\
+
+   ${branch} the default, please run: \e\
+
+   sudo port install python_select \e\
+
+   sudo python_select ${name}
+.Ed
 .It Ic revision
 Local revision number of
 .Nm .
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/macports-changes/attachments/20100111/c4830582/attachment.html>