From owner-freebsd-doc@FreeBSD.ORG Tue Aug 10 09:20:28 2004 Return-Path: Delivered-To: freebsd-doc@hub.freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 06D0C16A4CE for ; Tue, 10 Aug 2004 09:20:28 +0000 (GMT) Received: from freefall.freebsd.org (freefall.freebsd.org [216.136.204.21]) by mx1.FreeBSD.org (Postfix) with ESMTP id C47C643D55 for ; Tue, 10 Aug 2004 09:20:27 +0000 (GMT) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (gnats@localhost [127.0.0.1]) by freefall.freebsd.org (8.12.11/8.12.11) with ESMTP id i7A9KRPt056661 for ; Tue, 10 Aug 2004 09:20:27 GMT (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.12.11/8.12.11/Submit) id i7A9KR1W056660; Tue, 10 Aug 2004 09:20:27 GMT (envelope-from gnats) Date: Tue, 10 Aug 2004 09:20:27 GMT Message-Id: <200408100920.i7A9KR1W056660@freefall.freebsd.org> To: freebsd-doc@FreeBSD.org From: Aasmund Eikli Subject: Re: docs/66775: Clarification that port names should not contain version numbers X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list Reply-To: Aasmund Eikli List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 10 Aug 2004 09:20:28 -0000 The following reply was made to PR docs/66775; it has been noted by GNATS. From: Aasmund Eikli To: Peter Pentchev Cc: bug-followup@freebsd.org Subject: Re: docs/66775: Clarification that port names should not contain version numbers Date: Tue, 10 Aug 2004 11:13:00 +0200 Looks good! A very minor point though, shouldnt "not duplicate ports" be "no duplicate ports"? I'm new at this, so probably very rusty. Cheers Aasmund Peter Pentchev wrote: > On Sat, Jul 31, 2004 at 09:00:45PM +0000, Aasmund Eikli wrote: > >>The following reply was made to PR docs/66775; it has been noted by GNATS. >> >>From: Aasmund Eikli >>To: freebsd-gnats-submit@FreeBSD.org >>Cc: >>Subject: Re: docs/66775: Clarification that port names should not contain >> version numbers >>Date: Sat, 31 Jul 2004 22:52:16 +0200 >> >> Doc diffs to reflect suggestions: >> >> --- article.sgml Tue Jul 27 16:34:49 2004 >> +++ article.sgml Sat Jul 31 15:35:56 2004 >> @@ -2418,7 +2418,9 @@ >> >> Upgrade the copied port to the new version >> (remember >> to change the PORTNAME so there >> - are not duplicate ports with the same name). >> + are not duplicate ports with the same name). >> + Alternatively, change LATEST_LINK >> + depending on the purpose. >> > > > I think that 'remmeber to change the PORTNAME' and 'change LATEST_LINK' > clauses should be at the same level of "nesting" (parenthesized or not) > to avoid confusion - this way, it might seem that changing LATEST_LINK > is an alternative to upgrading the port :) How about something like > this instead? > > Index: doc/en_US.ISO8859-1/articles/committers-guide/article.sgml > =================================================================== > RCS file: /home/ncvs/doc/en_US.ISO8859-1/articles/committers-guide/article.sgml,v > retrieving revision 1.207 > diff -u -r1.207 article.sgml > --- doc/en_US.ISO8859-1/articles/committers-guide/article.sgml 8 Aug 2004 13:43:53 -0000 1.207 > +++ doc/en_US.ISO8859-1/articles/committers-guide/article.sgml 9 Aug 2004 12:21:10 -0000 > @@ -2431,9 +2431,10 @@ > > > > - Upgrade the copied port to the new version (remember > - to change the PORTNAME so there > - are not duplicate ports with the same name). > + Upgrade the copied port to the new version. Remember > + to change either the PORTNAME or > + the LATEST_LINK variable so there > + are not duplicate ports with the same name. > > > > >> --- book.sgml Sat Jul 31 15:40:21 2004 >> +++ book.sgml Sat Jul 31 15:52:11 2004 >> @@ -1064,7 +1064,10 @@ >> Data::Dumper module becomes >> p5-Data-Dumper. If the software in question >> has numbers, hyphens, or underscores in its name, you may >> include >> - them as well (like kinput2). >> + them as well (like kinput2). >> + Make sure that the PORTNAME variable and the >> + PORTVERSION variable contains the name > > > ITYM 'contain' here, since both variables form the sentence subject :) > > >> and the >> + version number of the port respectively. You should not mix >> the two. > > > A minor point, but I've gathered the impression that two spaces are > preferred before the start of a new sentence. How about this? > > Index: doc/en_US.ISO8859-1/books/porters-handbook/book.sgml > =================================================================== > RCS file: /home/dcvs/doc/en_US.ISO8859-1/books/porters-handbook/book.sgml,v > retrieving revision 1.476 > diff -u -r1.476 book.sgml > --- doc/en_US.ISO8859-1/books/porters-handbook/book.sgml 9 Aug 2004 11:51:37 -0000 1.476 > +++ doc/en_US.ISO8859-1/books/porters-handbook/book.sgml 9 Aug 2004 12:29:31 -0000 > @@ -1071,7 +1071,11 @@ > Data::Dumper module becomes > p5-Data-Dumper. If the software in question > has numbers, hyphens, or underscores in its name, you may include > - them as well (like kinput2). > + them as well (like kinput2). Make sure that > + the PORTNAME and > + PORTVERSION variables contain the name and > + the version of the port respectively. You should not mix the > + two. > > > > > Thanks for your work on this :) > > G'luck, > Peter >