From owner-freebsd-doc@FreeBSD.ORG Wed Jan 7 06:54:09 2009 Return-Path: Delivered-To: freebsd-doc@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id C4ADA106564A; Wed, 7 Jan 2009 06:54:09 +0000 (UTC) (envelope-from frank@esperance-linux.co.uk) Received: from mailout.zetnet.co.uk (mailout.zetnet.co.uk [194.247.47.231]) by mx1.freebsd.org (Postfix) with ESMTP id 4F6F88FC16; Wed, 7 Jan 2009 06:54:08 +0000 (UTC) (envelope-from frank@esperance-linux.co.uk) Received: from irwell.zetnet.co.uk ([194.247.47.48] helo=zetnet.co.uk) by mailout.zetnet.co.uk with esmtp (Exim 4.63) (envelope-from ) id 1LKSIm-0001DL-P1; Wed, 07 Jan 2009 06:54:04 +0000 Received: from melon.esperance-linux.co.uk (54-144.adsl.zetnet.co.uk [194.247.54.144]) by zetnet.co.uk (8.14.1/8.14.1/Debian-9) with ESMTP id n076s351004041; Wed, 7 Jan 2009 06:54:03 GMT Received: by melon.esperance-linux.co.uk (Postfix, from userid 1001) id 3EDFBFCB841; Wed, 7 Jan 2009 06:53:58 +0000 (GMT) Date: Wed, 7 Jan 2009 06:53:58 +0000 From: Frank Shute To: Giorgos Keramidas Message-ID: <20090107065358.GA36732@melon.esperance-linux.co.uk> Mail-Followup-To: Giorgos Keramidas , Gabor PALI , freebsd-doc@freebsd.org References: <4956903C.5060405@FreeBSD.org> <874p0f9dv7.fsf@kobe.laptop> <20090104203631.GA24306@melon.esperance-linux.co.uk> <87iqosgrva.fsf@kobe.laptop> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <87iqosgrva.fsf@kobe.laptop> User-Agent: Mutt/1.4.2.3i X-Face: *}~{PHnDTzvXPe'wl_-f%!@+r5; VLhb':*DsX%wEOPg\fDrXWQJf|2\,92"DdS%63t*BHDyQ|OWo@Gfjcd72eaN!4%NE{0]p)ihQ1MyFNtWL X-Operating-System: FreeBSD 6.3-RELEASE-p2 i386 X-Organisation: 'http://www.shute.org.uk/' X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.1.7 (zetnet.co.uk [194.247.46.1]); Wed, 07 Jan 2009 06:54:04 +0000 (GMT) Cc: Gabor PALI , freebsd-doc@freebsd.org Subject: Re: [RFC] A Handbook Section on Updating the Documentation Set X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list Reply-To: Frank Shute List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 07 Jan 2009 06:54:10 -0000 On Tue, Jan 06, 2009 at 09:24:25PM +0200, Giorgos Keramidas wrote: > > On Sun, 4 Jan 2009 20:36:31 +0000, Frank Shute wrote: > >On Sun, Jan 04, 2009 at 07:31:56PM +0200, Giorgos Keramidas wrote: > >>On Sat, 27 Dec 2008 21:29:48 +0100, Gabor PALI wrote: > >>> http://people.freebsd.org/~pgj/patches/2008/12/27/updating-upgrading-documentation.patch.diff > >> > >> Ping... Any news about this patch? > > > > Hi Giorgos, > > > > If you remember, you asked me if I could get the page I wrote about > > using csup to update the docs: > > > > http://www.shute.org.uk/misc/freebsd_uptodate.html > > > > into some sort of state to be incorporated into the updating section > > of the handbook. > > Hi Frank, > > "Yes", and if you can review the existing patch by Gabor Pali :) I've had a look at the patch and I like it. I wish it had existed in the docs before! A niggle though: Are the docs going to start using s/cvsup/csup/? ATM, there's only a note in "A.6 Using CVSup" about using csup instead of cvsup; but the chapter on installing ports uses csup. It's all a bit inconsistent. I think Gabor's patch should use csup & have a note about using cvsup if you've got an OS < 6.2. As far as I can see, only developers who want to pull the CVS files need cvsup & those with older releases... although they can install the csup port with it's fewer dependencies. I didn't see any errors in it otherwise & I thought it gave a nice easy to follow guide which is what's needed. > > > I've built the docs with Gabor's above patch applied & have started > > work on rejigging that section. > > > > You can see how far I've got. I've only done one page (which is bound > > to change) & largely worked on the css, so it's easier to mark-up into > > sgml: > > > > http://www.shute.org.uk/freebsd/synopsis.html > > Don't spend too much time tweaking the CSS style. We don't often make > changes in that area. I wanted to tweak the CSS on my site so it more closely followed that of FreeBSD. I develop my site by shamelessly copying ;) > > > I've made an executive decision to change mentions of cvsup to csup > > where appropriate since it's in base. > > Rene Ladan (added to the Cc: list) wanted to write about csup too, if my > memory does not fool me. Gabor and Rene had a discussion about this, so > before you spend a lot of time writing a long description of csup, maybe > it would be a good idea to talk to Gabor and Rene. I think my write-up on csup is largely redundant although the: cd /usr/src make update cd /usr/ports make fetchindex stuff should be covered somewhere & I don't think it is. > > I'm glad that you are willing to help with the doc updating section. We > can always use a bit of help with the documentation :-) It's a pleasure :) I'll hang around on doc@ and if I can help in any capacity I'll try and do so. I'm yet to read the fdp primer all the way through, so I'm a bit useless ATM :( > > Cheers, > Giorgos > Regards, -- Frank Contact info: http://www.shute.org.uk/misc/contact.html