Bug 27807

Summary: [PATCH] The port variables for optional packages aren't documented
Product: Documentation Reporter: mwm
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description mwm 2001-06-01 07:50:01 UTC 
The various WANT/HAVE ports Makefile variables arent't documented in
the porters handbook. Neither is WITHOUT_X.

Fix: Apply the attached patch to the porters handbook. WITHOUT_X has
already been documented in the make.conf man page. WITH/WITHOUT_* for
the WANT/HAVE variables should be done after this patch is
committed. And yes, I'm willing to write that up as well.
How-To-Repeat: 
Read the porters handbook looking for information on WITH_GIMP, etc.
Comment 1 dima 2001-06-01 08:19:03 UTC 
mwm@mired.org writes:
> Apply the attached patch to the porters handbook. WITHOUT_X has
> already been documented in the make.conf man page. WITH/WITHOUT_* for
> the WANT/HAVE variables should be done after this patch is
> committed. And yes, I'm willing to write that up as well.

I hope you don't intend on documenting (WANT|HAVE)_* in the man page;
they certainly don't belong there.  Sticking them along side the
discussion of dependencies or some such in the Porter's Handbook would
be great, though.

> +      <para>The easiest of these to use is
> +	<literal>WITHOUT_X</literal>. If the port can be built both

Isn't WITHOUT_X a make variable?  I.e., shouldn't it be marked up with
<makevar>?

Other than that, this looks great!  I'll commit it later today.

					Dima Dorfman
					dima@unixfreak.org
Comment 2 mwm 2001-06-01 19:14:07 UTC 
Dima Dorfman <dima@unixfreak.org> types:
> mwm@mired.org writes:
> > Apply the attached patch to the porters handbook. WITHOUT_X has
> > already been documented in the make.conf man page. WITH/WITHOUT_* for
> > the WANT/HAVE variables should be done after this patch is
> > committed. And yes, I'm willing to write that up as well.
> I hope you don't intend on documenting (WANT|HAVE)_* in the man page;
> they certainly don't belong there.  Sticking them along side the
> discussion of dependencies or some such in the Porter's Handbook would
> be great, though.

Nope, I wasn't going to do that. What would go in the man page would
be the WITH/WITHOUT variables.

> > +      <para>The easiest of these to use is
> > +	<literal>WITHOUT_X</literal>. If the port can be built both
> Isn't WITHOUT_X a make variable?  I.e., shouldn't it be marked up with
> <makevar>?

Yes, it is, and yes, it should. I should have caught that when I
proofed it.

	Thanx,
	<mike
--
Mike Meyer <mwm@mired.org>			http://www.mired.org/home/mwm/
Independent WWW/Perforce/FreeBSD/Unix consultant, email for more information.
Comment 3 dd freebsd_committer freebsd_triage 2001-06-02 04:00:09 UTC 
State Changed
From-To: open->closed

Committed, thanks!