Bug 29807

Summary: [PATCH] XFREE86_VERSION is undocumented
Product: Documentation Reporter: mwm
Component: Books & ArticlesAssignee: Tom Rhodes <trhodes>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description mwm 2001-08-17 16:40:00 UTC 
	The XFREE86_VERSION variable used by ports isn't documented.

Fix: The following patch adds an entry for XFREE86_VERSION to the make.conf
man page.
How-To-Repeat: 
	man make.conf
Comment 1 dima 2001-08-17 22:27:20 UTC 
Mike Meyer <mwm@mired.org> writes:
> --- make.conf.5	Fri Aug  3 10:16:50 2001
> +++ /tmp/make.conf.5	Fri Aug 17 10:33:14 2001
> @@ -745,6 +745,12 @@
>  Should be set to where the X11 distribution has been
>  installed if it is installed anywhere other than
>  .Pa /usr/X11R6 .
> +.It Va XFREE86_VERSION
> +.Pq Vt str
> +Set this to 4 if you have are using XFree86 version 4 instead of
> +XFree86 version 3.

This should probably describe what it is, not just its possible
values.  Saying something like "set this to the major version of the
preferred XFree86 release" would be better, methinks.  After that, you
can say that the default is 3 (for now).

Also, please avoid using first- or second-person pronouns in manual
pages or other documentation.

> +.Pa XFree86-4
> +ports.

What are these doing here?
Comment 2 dd freebsd_committer freebsd_triage 2001-09-03 17:00:36 UTC 
State Changed
From-To: open->feedback

Awaiting updated patch (or explanation why it it's fine the way it is) from 
the originator.
Comment 3 dd freebsd_committer freebsd_triage 2001-09-03 17:00:36 UTC 
Responsible Changed
From-To: freebsd-doc->dd

I'll follow up.
Comment 4 mwm 2002-02-17 06:33:09 UTC 
How about:

Set this to the major version of the XFree86 release installed on the
system. Currently the default value is 3, and the only other valid
value is 4.
Comment 5 Tom Rhodes freebsd_committer freebsd_triage 2003-02-25 15:48:33 UTC 
State Changed
From-To: feedback->analyzed

Over to me.
Comment 6 Tom Rhodes freebsd_committer freebsd_triage 2003-02-25 15:48:33 UTC 
Responsible Changed
From-To: dd->trhodes

Over to me.
Comment 7 Tom Rhodes freebsd_committer freebsd_triage 2004-12-15 13:48:15 UTC 
Patch is for deprecated option, from the ports/UPDATING file:

  The XFREE86_VERSION variable is deprecated and has been replaced by the
  X_WINDOW_SYSTEM variable. X_WINDOW_SYSTEM may be set to xorg, xfree86-4, or
  xfree86-3.  X_WINDOW_SYSTEM defaults to xorg on FreeBSD-current.  If you are
  switching to xorg, you should follow this set of commands to cleanly upgrade:

  pkg_delete -f /var/db/pkg/imake-4* /var/db/pkg/XFree86-*
  cd /usr/ports/x11/xorg && make install
  pkgdb -F

  Users of -stable or older -current can switch to X.Org by setting
  X_WINDOW_SYSTEM=xorg in make.conf and following the same process.

I could probably document this instead.

--
Tom Rhodes
Comment 8 Pav Lucistnik freebsd_committer freebsd_triage 2005-08-18 20:51:51 UTC 
X_WINDOW_SYSTEM is documented both in FAQ and in Installing X11 chapter
of Handbook. I think you can close this PR, Tom.

-- 
Pav Lucistnik <pav@oook.cz>
              <pav@FreeBSD.org>

And now something completely different.
Comment 9 Tom Rhodes freebsd_committer freebsd_triage 2005-09-15 10:15:03 UTC 
State Changed
From-To: analyzed->closed

I'm inclined to agree with Pav here.  This is documented elsewhere 
and we have at least a dozen other ports knobs only documented 
in the Makefile.  Closed.