From owner-freebsd-doc@FreeBSD.ORG Sat Apr 25 00:27:20 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 AACC7106564A for ; Sat, 25 Apr 2009 00:27:20 +0000 (UTC) (envelope-from pali.gabor@googlemail.com) Received: from mail-ew0-f171.google.com (mail-ew0-f171.google.com [209.85.219.171]) by mx1.freebsd.org (Postfix) with ESMTP id 0D2188FC18 for ; Sat, 25 Apr 2009 00:27:19 +0000 (UTC) (envelope-from pali.gabor@googlemail.com) Received: by ewy19 with SMTP id 19so1219253ewy.43 for ; Fri, 24 Apr 2009 17:27:18 -0700 (PDT) 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=C5IWNeJfFxbpuhRSanqv1pKhek9O8FITblMICY4S/ds=; b=R9c7vuwOrPqKwOhlNNDY6jLJXc1fQ7lu4bFe1zwZfhtHZQVtpzo1PqLqkyHR4ZH4Jm rDSeLQFY2taipvzZ0/7Emoz6UEQeFdBwzggaWd1Iwp4rVcbZVWdjdv5GerzSJ7gkGsbm le9H/FoUnqRPhRbLSKpRIMqmbvmg6VhwxOfEw= 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=op+ds9Hnb1QfpfHWLChE9fgUBCQtoAxipc0jyVH0GrxS8Xz77kbaw8FtHLVY5t/Bj/ CwG4D4WzD0oQ+zNC7tgEjocNgPznqNuyy1+dUzKnmIjyiuxgGv7a6tGeSoCAXMk6P08K JDk/u4JCaLsB6MQtxpNCSu7rXKSBdZAwBhJaQ= Received: by 10.210.136.10 with SMTP id j10mr2009410ebd.7.1240619238700; Fri, 24 Apr 2009 17:27:18 -0700 (PDT) Received: from beehive.inf.elte.hu (beehive.inf.elte.hu [157.181.166.90]) by mx.google.com with ESMTPS id 5sm2550814eyh.40.2009.04.24.17.27.17 (version=TLSv1/SSLv3 cipher=RC4-MD5); Fri, 24 Apr 2009 17:27:17 -0700 (PDT) Sender: =?UTF-8?B?UMOBTEkgR8OhYm9yIErDoW5vcw==?= Message-ID: <49F259C3.1040704@FreeBSD.org> Date: Sat, 25 Apr 2009 02:30:59 +0200 From: Gabor PALI Organization: The FreeBSD Project User-Agent: Thunderbird 2.0.0.19 (X11/20090128) MIME-Version: 1.0 To: freebsd-doc@freebsd.org References: <49E837A0.6060503@FreeBSD.org> <47d0403c0904222141g3c99d217u1e90e9d47424563c@mail.gmail.com> In-Reply-To: <47d0403c0904222141g3c99d217u1e90e9d47424563c@mail.gmail.com> X-Enigmail-Version: 0.95.7 Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: 7bit Cc: Subject: Re: [PATCH] A Handbook Section on Documentation Ports 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, 25 Apr 2009 00:27:21 -0000 Hi, Ben Kaduk wrote: > I appear to be a bit behind in my mail, but it looks like no one has > commented, and this still hasn't hit the tree ... Well, we are still waiting for Mr. Giorgos Keramidas' review :P > I do think it's worth mentioning the documentation ports, and have > only a couple comments on the patch itself: Great! > > How to keep your documentation up to date with > - CVSup. > > > This doesn't seem to have made it into the HTML preview that you linked > in your follow-up? > In any case, the comma is probably unnecessary. OK > + An option to ease the process of documentation updating > + while still staying close to the sources, is to use the > > this line is a bit awkward. Perhaps "An easier way to update the > documentation while still using updated sources is to use the [...]" OK > + Basically, this technique implements almost the same method > + as CVSup that we have already seen, > > "that we have already seen" is redundant. OK > + command, and compilation of the sources might be omitted as the > + &os; package building cluster builds packages from the > + documentation ports. Thus, the user can decide to update > + documentation from a pre-built binary package. > > > I think it might be better to say "and compilation of the sources > might be skipped through the use of a pre-built binary package > provided by the &os; package-building cluster." OK > + If building from sources is preferred, the mandatory > + documentation tools will be automatically installed as a > > I would s/mandatory documentation tools/tools needed to build the documentation/ OK > + There is a master port, + role="package">misc/freebsd-doc-en where the > > comma after freebsd-doc-en. OK > + English documentation only, probably the most requested > + language for the majority of the users. > > I don't think that "probably ...users" is necessary OK > + To install a documentation port by source, issue the > > s/by/from/ OK > + If resources are not available for the complete build and > + installation of the documentation ports, or we simply want to > > This sounds a bit awkward. "compilation" is perhaps not strictly > correct, so maybe "the complete process of building and installing the > documentation ports". OK > + have the documentation installed in a more convenient way, > + binary packages come handy. They can be managed as normal > > s/come handy/are a convenient option/ OK > Thanks for writing these up! Thanks for the comments and the review :) Here is the updated version of the patch and the HTML version: http://people.freebsd.org/~pgj/patches/2009/04/12/documentation-ports.4.diff http://people.freebsd.org/~pgj/patches/2009/04/12/html/updating-upgrading.html Cheers, :g