From owner-freebsd-doc@FreeBSD.ORG Sat Dec 27 22:32:13 2008 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 85951106564A; Sat, 27 Dec 2008 22:32:13 +0000 (UTC) (envelope-from r.c.ladan@gmail.com) Received: from mail-ew0-f21.google.com (mail-ew0-f21.google.com [209.85.219.21]) by mx1.freebsd.org (Postfix) with ESMTP id 923F58FC0C; Sat, 27 Dec 2008 22:32:12 +0000 (UTC) (envelope-from r.c.ladan@gmail.com) Received: by ewy14 with SMTP id 14so5166411ewy.19 for ; Sat, 27 Dec 2008 14:32:11 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=domainkey-signature:received:received:message-id:date:from :user-agent:mime-version:to:cc:subject:references:in-reply-to :x-enigmail-version:content-type:content-transfer-encoding; bh=QfU2o+C5mg33Ql8ZWf1Eb+JifqkqIUZZaaxkZJzkhQY=; b=Wtp8pw4DQVBak13SQ7OnxrSrf63qrNXOtSDvzw0KW6IEJ5z2hbtwNj32nAfLudUHJT 1NfewLZ0BvXfzHWZIx0im/ZPUXq7L9FAho33tyHIal6ZDCvTp2+lIAyJp0zng1gHQXBx IbykvpJlqEQQXenFW7M33XgPmKOddfrAnQd1o= DomainKey-Signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma; h=message-id:date:from:user-agent:mime-version:to:cc:subject :references:in-reply-to:x-enigmail-version:content-type :content-transfer-encoding; b=YsGADKjlcRdymHA0LxXoVeJqUvgE69Lu+9IFIYEzNG6l/qzhaFFKfipcv6/gYkN/LM e7u+qk8eJ41AmYkF948i/ocbjct8SXPJot43qgc/onnQ0CZDUMWtIEgQMv0ZV4x6/BLf rmMtDWm4EFVmEvfPPzk13MfUx3QT5YNujqJe0= Received: by 10.210.144.3 with SMTP id r3mr14301078ebd.67.1230417131599; Sat, 27 Dec 2008 14:32:11 -0800 (PST) Received: from self.rene-ladan.nl ([77.163.174.49]) by mx.google.com with ESMTPS id 6sm43581886nfv.15.2008.12.27.14.32.09 (version=TLSv1/SSLv3 cipher=RC4-MD5); Sat, 27 Dec 2008 14:32:10 -0800 (PST) Message-ID: <4956ACE8.7020201@gmail.com> Date: Sat, 27 Dec 2008 23:32:08 +0100 From: Rene Ladan User-Agent: Thunderbird 2.0.0.18 (X11/20081123) MIME-Version: 1.0 To: Giorgos Keramidas References: <4956903C.5060405@FreeBSD.org> <87sko9wda1.fsf@kobe.laptop> <495696F1.7080207@freebsd.org> <87d4fdpb46.fsf@kobe.laptop> <87prjdl1zm.fsf@kobe.laptop> In-Reply-To: <87prjdl1zm.fsf@kobe.laptop> X-Enigmail-Version: 0.95.6 Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit Cc: Rene Ladan , freebsd-doc@freebsd.org, Gabor PALI 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 List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 27 Dec 2008 22:32:13 -0000 Giorgos Keramidas schreef: > On Sat, 27 Dec 2008 23:22:01 +0200, Giorgos Keramidas wrote: >> On Sat, 27 Dec 2008 21:58:25 +0100, Rene Ladan wrote: >>>>> [1] http://lists.freebsd.org/pipermail/freebsd-doc/2008-December/015099.html >>>>> [2] http://people.freebsd.org/~pgj/patches/2008/12/27/updating-upgrading-documentation.patch.diff >>>> It goes without saying that after his patience with all my comments >>>> about the patch, and the changes we made this afternoon, Gabor has my >>>> full approval for the patch :) >>> Indeed, but my tag changes seem to be lost. Maybe I am too picky :) >> I'm sorry. I will go through the tag diff and see if it's easy to merge >> them into this :) > > Hi Rene, > > Looking at the 2nd level diff from the private emails, I could see the > following tag changes: > > - &prompt.root; cvsup -h cvsup10.FreeBSD.org -g -L 2 /usr/share/examples/cvsup/doc-supfile > + &prompt.root; csup -h cvsupN.country.FreeBSD.org -L 2 /usr/share/examples/cvsup/doc-supfile > + > + Here, N is a number indicating which copy > + of the server to use, and country is the > + two-letter ISO country code of a (preferably geographically > + close) country. > > I can understand the reasoning behind this part of the changes. It is a > good idea to avoid using a specific CVSup server in the docs, because > users will tend to copy/paste the name of the server and won't > necessarily bother picking the right one for their setup. On the other > hand, having examples that one can copy and paste is nice too; it avoids > the need for a lengthy explanation of what cvsup"N"."country" means, and It's not that long :) > we have servers that don't match the country-based pattern. > Oops, I didn't know that (I should look up the list of CVSup servers). > I think I like the "cvsup10" version, since we already mention in the > added text that cvsup is merely an example: > > so the documentation sources can be fetched from one of > the CVSup servers, > like cvsup10.FreeBSD.org, by typing: > > If we change to a template name, then we should update the > text before the commands too, and we should add a link to the Handbook > section that lists the CVSup servers. A pointer to: > > the list of CVSup mirrors > > should suffice for that. > I guess I mean this list. I must admit I only looked at the diff itself, not at the surrounding text. > - &prompt.root; rsync -rltvz docsnap.sk.FreeBSD.org::docsnap /usr/share/doc > + &prompt.root; rsync -rltvz docsnap.sk.FreeBSD.org::docsnap /usr/share/doc > > This one is ok. We don't have many docsnap servers, so is > probably fine here. If we start mirroring docsnap files in multiple > places, and there are several to choose, we may have to revert to the > element, but for now is fine :) > And maybe point to a list of docsnap servers ;) > Are there any other tag changes that I missed? > Nope. Regards, Rene -- http://www.rene-ladan.nl/ GPG fingerprint = E738 5471 D185 7013 0EE0 4FC8 3C1D 6F83 12E1 84F6 (subkeys.pgp.net)