Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 11 Jun 2012 16:20:33 -0700
From:      Dave Hayes <dave@jetcafe.org>
To:        Rainer Duffner <rainer@ultra-secure.de>
Cc:        freebsd-stable@freebsd.org, Daniel Kalchev <daniel@digsys.bg>
Subject:   Documenting ports options (was Re: Why Are You NOT Using FreeBSD ?)
Message-ID:  <201206112320.q5BNKXWO029603@hugeraid.jetcafe.org>
In-Reply-To: <90425E82-5475-491F-AE88-00B0774F058D@ultra-secure.de> 
References:  <CAOgwaMvsv3e1TxDauV038Pp7LRiYeH7oAODE%2Bw-pxHt9oGrXMA@mail.gmail.com> <201206020012.q520CEcf057568@hugeraid.jetcafe.org> <20120602004230.GA14487@in-addr.com> <201206040224.q542OBqk085897@hugeraid.jetcafe.org> <20120604043233.GB32597@lonesome.com> <201206040841.q548fVHa091169@hugeraid.jetcafe.org> <CADLo83-9jE1zAtdXrA78=K5AE7yR4UsMh=efeC5L4kXijaDFaQ@mail.gmail.com> <201206041841.q54IfUow001060@hugeraid.jetcafe.org> <20120604191343.GF10783@isuckatdomains.isuckatdomains.net> <201206041932.q54JWONA001600@hugeraid.jetcafe.org> <4FCDA15C.2000700@digsys.bg> <201206061859.q56IxvLx045828@hugeraid.jetcafe.org> <90425E82-5475-491F-AE88-00B0774F058D@ultra-secure.de>

next in thread | previous in thread | raw e-mail | index | archive | help
[ This probably should be redirected to freebsd-ports but I am not
  subscribed so the anal mailer will likely reject such a submission ]

Rainer Duffner <rainer@ultra-secure.de> writes:
> Am 06.06.2012 um 20:59 schrieb Dave Hayes:
>> I believe this is the first time I've seen more documentation labeled as
>> "extraneous". :) I had thought to suggest an implementation by having a
>> simple pkg-option-desr file which describes the options and implications
>> in each port. Are you suggesting that such a file would be unwelcome? 
>> 
> No, but take a look at the nginx port, which (I'm too lazy to count)
> has gained a couple of dozens of options over the years.

This is a port I use often, and yes...it's a lot of work to document it.
It is good to read the nginx wiki to learn what these are and perhaps
any initial foray into documenting these options should merely be a set
of links, each one telling us where this option is discussed on the
nginx wiki. 

I had to go read the wiki too, and it's required reading if you do advanced
nginx work like I do. Still, it takes 5 minutes to add links to a text
file in the port eh? 

> Asking him to do even more work - I wouldn't dare to do that ;-)

So don't ask, just write some links. ;) 

> Sometimes, options only make sense in context of the selection of
> options of other ports and it thus may no be easily explainable in one
> line.

I don't understand Are you saying this is a reason not to document what
these options do?

> Personally, I don't need more frequent FreeBSD-releases but two or
> maybe three ports-tree freezes per year would be good.

While I have learned a bit more about ports by reading this and other
threads, I rarely worry about ports freezes. Production software in
ports is a moving target (security fixes, bug fixes, etc). I use 
portsnap a lot.
-- 
Dave Hayes - Consultant - Altadena CA, USA - dave@jetcafe.org 
>>> The opinions expressed above are entirely my own <<<

Exaggeration is a standard peculiarity of man. To deprecate
is often a form of exaggeration which people do not notice
because it appears to be its opposite.










Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201206112320.q5BNKXWO029603>