Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 21 Jun 1999 10:11:26 +1000 (EST)
From:      John Birrell <jb@cimlogic.com.au>
To:        billf@jade.chc-chimes.com (Bill Fumerola)
Cc:        jb@cimlogic.com.au, cvs-committers@FreeBSD.org, cvs-all@FreeBSD.org
Subject:   Re: cvs commit: doc/en/handbook/ports chapter.sgml
Message-ID:  <199906210011.KAA07097@cimlogic.com.au>
In-Reply-To: <Pine.BSF.3.96.990620192823.28637A-100000@jade.chc-chimes.com> from Bill Fumerola at "Jun 20, 1999  7:34:16 pm"

next in thread | previous in thread | raw e-mail | index | archive | help
Bill Fumerola wrote:
> On Mon, 21 Jun 1999, John Birrell wrote:
> 
> > I understand that it is useful to have the history of __FreeBSD_version
> > documented in a manner that is convenient for ports people, but when
> > you look at it from the other direction, doc/en/handbook/ports seems
> > a bit odd. 
> 
> *shrug* At this point it's only to help people understand what happened
> when.
> 
> Perhaps that whole section could be replaced with a link to
> http://www.FreeBSD.org/cgi/cvsweb.cgi/src/sys/sys/param.h

That won't work because sys/param.h only shows what the latest value
is, not why it is what it is, or why it was what it was. 8-)
It is the RCS file that contains the reason why the developer changed
it, but the commit message is unsuitable for the documentation (no
consistent style). And the commit message is always in (nerdy) English -
we need a structure that allows for translation to other languages.

As a developer, I would never have thought to look in the ports section
of the handbook for this sort of information. IMHO, the ports section
is for use more often by people creating ports from other people's
code. We need to document things in a way that suits the "other
people" too.

-- 
John Birrell - jb@cimlogic.com.au; jb@freebsd.org http://www.cimlogic.com.au/
CIMlogic Pty Ltd, GPO Box 117A, Melbourne Vic 3001, Australia +61 418 353 137


To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe cvs-all" in the body of the message




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