From owner-freebsd-doc@FreeBSD.ORG Sun Dec 28 15:46:01 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 047B01065673; Sun, 28 Dec 2008 15:46:01 +0000 (UTC) (envelope-from r.c.ladan@gmail.com) Received: from nf-out-0910.google.com (nf-out-0910.google.com [64.233.182.188]) by mx1.freebsd.org (Postfix) with ESMTP id 354578FC08; Sun, 28 Dec 2008 15:46:00 +0000 (UTC) (envelope-from r.c.ladan@gmail.com) Received: by nf-out-0910.google.com with SMTP id h3so864112nfh.33 for ; Sun, 28 Dec 2008 07:45:59 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.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=abHxzm7n3+grg4SEYhsBIWxtQDknFSFkFvDinALg3xU=; b=cIuwlzm+3aZbvcC4PAiJX88AwTgAjfrrO2xgysZaBnrLHFE6RHWzl8sfAjXEg2YJlU +O4LQy+yaEoA8/k6vvfaq1sGAPr+7xEYIuXqCU2IS1YCP+I7WDYv1zi3HYmZCXfg8PK8 cFOCihAL9/VHGZhrIsfALwo39i1XuRM0kHGkc= DomainKey-Signature: a=rsa-sha1; c=nofws; d=gmail.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=CbRTIqVC/Vv/LLhEYtKXWn+ceO1yfbAohoYKuLSjbGS8sLwqoG+NoYEYZ3aNQiy4no Qzk3VyJr2MU14xnVDBUlytEBNWZq6w/OOwqUZFgvjD2q3WonW1LUt5KGbHpacmcZfITc CuCCxcvWysYnZYW1NXxEPMxxK+Ra/DTAs0lNI= Received: by 10.210.16.10 with SMTP id 10mr11258023ebp.196.1230479158879; Sun, 28 Dec 2008 07:45:58 -0800 (PST) Received: from self.rene-ladan.nl ([77.163.174.49]) by mx.google.com with ESMTPS id k9sm41978423nfh.17.2008.12.28.07.45.57 (version=TLSv1/SSLv3 cipher=RC4-MD5); Sun, 28 Dec 2008 07:45:57 -0800 (PST) Sender: Rene Ladan Message-ID: <49579F33.6020600@freebsd.org> Date: Sun, 28 Dec 2008 16:45:55 +0100 From: Rene Ladan Organization: The FreeBSD Project User-Agent: Thunderbird 2.0.0.18 (X11/20081123) MIME-Version: 1.0 To: Gabor PALI References: <4956903C.5060405@FreeBSD.org> <87sko9wda1.fsf@kobe.laptop> <495696F1.7080207@freebsd.org> <87d4fdpb46.fsf@kobe.laptop> <87prjdl1zm.fsf@kobe.laptop> <4956AF88.2030502@FreeBSD.org> In-Reply-To: <4956AF88.2030502@FreeBSD.org> 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 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: Sun, 28 Dec 2008 15:46:01 -0000 Gabor PALI schreef: > 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. > Makes sense. > >> 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]). > Ok, predefined hostnames are fine with me as long as there is one. Please commit ;) Rene -- http://www.rene-ladan.nl/ GPG fingerprint = ADBC ECCD EB5F A6B4 549F 600D 8C9E 647A E564 2BFC (subkeys.pgp.net)