docs/159551: ports(7) makes no mention of LOCALBASE

[Matthew Seaman]

>Number:         159551
>Category:       docs
>Synopsis:       ports(7) makes no mention of LOCALBASE
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sat Aug 06 16:30:13 UTC 2011
>Closed-Date:
>Last-Modified:
>Originator:     Matthew Seaman
>Release:        FreeBSD 8.2-STABLE amd64
>Organization:
Infracaninophile
>Environment:
System: FreeBSD lucid-nonsense.infracaninophile.co.uk 8.2-STABLE FreeBSD 8.2-STABLE #47 r224671: Sat Aug 6 10:59:06 BST 2011 root at lucid-nonsense.infracaninophile.co.uk:/usr/obj/usr/src/sys/LUCID-NONSENSE amd64


	
>Description:

ports(7) makes no mention of LOCALBASE, which is bizarre as it is the
master control for locating where ports will install files and look
for files when resolving dependencies.  ports(7) does mention PREFIX
but doesn't make it clear that the setting only applies to the port
currently being installed.  In fact, the current description of PREFIX
is likely to confuse readers into thinking that PREFIX does what
LOCALBASE does.

Also PREFIX generally inherits its setting from LOCALBASE unless
overridden. (Except for eg. Linux binaries where LINUXBASE is used
instead)

>How-To-Repeat:
	
>Fix:

	

--- ports.7.diff begins here ---
Index: ports.7
===================================================================
--- ports.7	(revision 224671)
+++ ports.7	(working copy)
@@ -408,10 +408,13 @@
 .It Va PKGFILE
 The full path to the package.
 .El
+.It Va LOCALBASE
+Where to install things in general, and where to search for files when
+resolving dependencies (usually
+.Pa /usr/local ) .
 .It Va PREFIX
-Where to install things in general
-(usually
-.Pa /usr/local ) .
+Where to install this port (usually set to the same as
+.Va LOCALBASE ) .
 .It Va MASTER_SITES
 Primary sites for distribution files if not found locally.
 .It Va PATCH_SITES
--- ports.7.diff ends here ---


>Release-Note:
>Audit-Trail:
>Unformatted: