From owner-freebsd-doc Sat Dec 7 7:13:43 2002 Delivered-To: freebsd-doc@freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 674A837B401 for ; Sat, 7 Dec 2002 07:13:41 -0800 (PST) Received: from crf-consulting.co.uk (pc-80-194-99-103-hy.blueyonder.co.uk [80.194.99.103]) by mx1.FreeBSD.org (Postfix) with ESMTP id 3F82F43E4A for ; Sat, 7 Dec 2002 07:13:40 -0800 (PST) (envelope-from nik@crf-consulting.co.uk) Received: from clan.nothing-going-on.org (clan.nothing-going-on.org [192.168.1.20]) by crf-consulting.co.uk (8.12.3/8.12.3) with ESMTP id gB7FDMTk008693; Sat, 7 Dec 2002 15:13:22 GMT (envelope-from nik@catkin) Received: from clan.nothing-going-on.org (localhost [127.0.0.1]) by clan.nothing-going-on.org (8.12.3/8.12.3) with ESMTP id gB7FDM2x002880; Sat, 7 Dec 2002 15:13:22 GMT (envelope-from nik@clan.nothing-going-on.org) Received: (from nik@localhost) by clan.nothing-going-on.org (8.12.3/8.12.3/Submit) id gB7FDLJO002879; Sat, 7 Dec 2002 15:13:21 GMT Date: Sat, 7 Dec 2002 15:13:21 +0000 From: Nik Clayton To: Giorgos Keramidas Cc: Michael Lucas , doc@FreeBSD.ORG Subject: Re: major surgery on a chapter? Message-ID: <20021207151321.GP96173@clan.nothing-going-on.org> References: <20011120213339.A16929@blackhelicopters.org> <20011121033504.GA55131@hades.hell.gr> Mime-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="kK1uqZGE6pgsGNyR" Content-Disposition: inline In-Reply-To: <20011121033504.GA55131@hades.hell.gr> User-Agent: Mutt/1.4i Organization: FreeBSD Project Sender: owner-freebsd-doc@FreeBSD.ORG Precedence: bulk List-ID: List-Archive: (Web Archive) List-Help: (List Instructions) List-Subscribe: List-Unsubscribe: X-Loop: FreeBSD.org --kK1uqZGE6pgsGNyR Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Wed, Nov 21, 2001 at 05:35:04AM +0200, Giorgos Keramidas wrote: > On 2001-11-20 21:33:39, Michael Lucas wrote: > > I'm doing a pass on the Handbook, and found that the ports chapter > > could really use some help. I've started to rewrite some stuff and > > add information, and found myself committing major surgery here and > > there. >=20 > If the changes are more than a certain percentage, say you change more > than 75% of the actual content, and the rest is still touched for > style issues here and there, it seems that a new `chapter.sgml' posted > in its entirety for review is what is called for :) >=20 > This is of course, my own humble opinion. My general rule of thumb is: If the structure of the chapter is staying the same, but I'm adding new information through out it, then commit that as one chunk. If I'm moving stuff around wholesale, but not rewriting it, then commit it as one chunk, with a note in the commit message that it's a move of content, so the translation teams can make the same change. If I'm taking an axe to the existing documentation and completely rewriting it then commit it as one chunk, with an appropriate note to the translation teams. Sometimes this means holding off on a commit, and keeping multiple copies of the files around, with notes on what change happened when. This is so that the commits that make the changes can happen in quick succession, and the documentation is not 'broken' for long periods of tiem. N --=20 FreeBSD: The Power to Serve http://www.freebsd.org/ (__) FreeBSD Documentation Project http://www.freebsd.org/docproj/ \\\'',) \/ \= ^ --- 15B8 3FFC DDB4 34B0 AA5F 94B7 93A8 0764 2C37 E375 --- .\._/= _) --kK1uqZGE6pgsGNyR Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.1 (FreeBSD) iD8DBQE98hARk6gHZCw343URAtEdAJ9aJJDehlEIPNonyP5u1cMG17wXwACfQWpT v2HzUyG+zWkxuC4oqxvCUNA= =eh1K -----END PGP SIGNATURE----- --kK1uqZGE6pgsGNyR-- To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message