From owner-freebsd-doc@FreeBSD.ORG Sat Dec 27 22:43:51 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 943AD1065670; Sat, 27 Dec 2008 22:43:51 +0000 (UTC) (envelope-from pali.gabor@googlemail.com) Received: from fg-out-1718.google.com (fg-out-1718.google.com [72.14.220.152]) by mx1.freebsd.org (Postfix) with ESMTP id DF61D8FC13; Sat, 27 Dec 2008 22:43:50 +0000 (UTC) (envelope-from pali.gabor@googlemail.com) Received: by fg-out-1718.google.com with SMTP id l26so1405455fgb.35 for ; Sat, 27 Dec 2008 14:43:49 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=googlemail.com; s=gamma; h=domainkey-signature:received:received:sender:message-id:date:from :organization:user-agent:mime-version:to:cc:subject:references :in-reply-to:x-enigmail-version:content-type :content-transfer-encoding; bh=THKPThhQ3Q96X7QqC1V/fS31X+gWkAE6iic4/H3yX3w=; b=fiPoNYh0sA/dNwGVxONDD+fjRixADmXzF4BiwHlwoHpkTs6qWbi9ppgtPJNu2LTDNo OgHTCPx0txDUKtAfHcnYI+dQzNhZ+8Ou+3OtyGicytdTiRpXpByj9zavaqs9/Ww5/4iY yqLgWTdhJVx53cMCjZVTrovJ1rnMOaKJi0vkc= DomainKey-Signature: a=rsa-sha1; c=nofws; d=googlemail.com; s=gamma; h=sender:message-id:date:from:organization:user-agent:mime-version:to :cc:subject:references:in-reply-to:x-enigmail-version:content-type :content-transfer-encoding; b=el3rfBOhr27eQBvSMd5BshujBHxFZGc307UGUTEGkh0bi+YNIjHqt312roFdZlp/v5 muL7Ckj2W/+sFFlAsEq9Sgb+qEd6e/GJ8ZlWg9ctug0M05ao0H94CvnYVBLwChSjP5In xSHnWFCJIMdBu8oU/5UVfkb+EbplNJG5dwPhw= Received: by 10.86.59.18 with SMTP id h18mr5703548fga.45.1230417829518; Sat, 27 Dec 2008 14:43:49 -0800 (PST) Received: from ?192.168.2.3? ([195.228.9.254]) by mx.google.com with ESMTPS id 4sm25093083fgg.44.2008.12.27.14.43.48 (version=TLSv1/SSLv3 cipher=RC4-MD5); Sat, 27 Dec 2008 14:43:48 -0800 (PST) Sender: =?UTF-8?B?UMOBTEkgR8OhYm9yIErDoW5vcw==?= Message-ID: <4956AF88.2030502@FreeBSD.org> Date: Sat, 27 Dec 2008 23:43:20 +0100 From: Gabor PALI Organization: The FreeBSD Project User-Agent: Thunderbird 2.0.0.17 (X11/20081023) 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.7 Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: 7bit Cc: Rene Ladan , 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 List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 27 Dec 2008 22:43:51 -0000 Giorgos Keramidas wrote: >> On Sat, 27 Dec 2008 21:58:25 +0100, Rene Ladan wrote: >>> Indeed, but my tag changes seem to be lost. Maybe I am too picky :) Reasons are explained below: - Some text have changed in the patch and got fixed meanwhile. > 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 > we have servers that don't match the country-based pattern. - I assumed that readers are able to replace cvsup with csup and pick a server for themselves, so there is no more explanation needed. > 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. Yep, we can add it. > - &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 :) I marked up the hostname and the target directory with because they could be changed by the user. Of course, there is only one Docsnap server at the moment; I simply tried to follow the markup traditions (see FDP Primer, 4.2.5.12 [1]). If we want to make it non-replaceable (as no more Docsnap servers), then I suggest to omit and elements (see FDP Primer, 4.2.4.8 [1]). Cheers, :g [1] http://www.freebsd.org/doc/en/books/fdp-primer/sgml-markup-docbook.html#AEN1810