From owner-freebsd-doc Thu Jul 25 7: 0:54 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 2EF0F37B400; Thu, 25 Jul 2002 07:00:47 -0700 (PDT) Received: from chiark.greenend.org.uk (chiark.greenend.org.uk [212.135.138.206]) by mx1.FreeBSD.org (Postfix) with ESMTP id 9800B43E72; Thu, 25 Jul 2002 07:00:45 -0700 (PDT) (envelope-from fanf@chiark.greenend.org.uk) Received: from fanf by chiark.greenend.org.uk with local (Exim 3.12 #1) id 17XjAa-0008CS-00 (Debian); Thu, 25 Jul 2002 15:00:44 +0100 Date: Thu, 25 Jul 2002 15:00:44 +0100 From: Tony Finch To: Giorgos Keramidas , doc@freebsd.org Cc: cvs@freebsd.org, dwmalone@freebsd.org Subject: Re: CVSROOT documentation patch Message-ID: <20020725150044.H8886@chiark.greenend.org.uk> References: <20020718163457.D32457@chiark.greenend.org.uk> <20020719202612.B8238@chiark.greenend.org.uk> <20020719204817.C8238@chiark.greenend.org.uk> <20020720154611.A1296@chiark.greenend.org.uk> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline User-Agent: Mutt/1.2.5i In-Reply-To: <20020720154611.A1296@chiark.greenend.org.uk>; from dot@dotat.at on Sat, Jul 20, 2002 at 03:46:11PM +0100 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 Current revision of the patch which addresses whitespace issues and my broken sgml... This would be followed up by a whitespace-only change. Tony. -- f.a.n.finch http://dotat.at/ ROCKALL MALIN SOUTH HEBRIDES: WESTERLY 5 OR 6 DECREASING 3 OR 4. RAIN OR DRIZZLE. MODERATE OR POOR, BECOMING GOOD IN NORTHWEST ROCKALL. --- article.sgml 10 Apr 2002 12:54:25 -0000 1.5 +++ article.sgml 25 Jul 2002 13:56:44 -0000 @@ -22,8 +22,6 @@ Stijn Hoop - $Date$ - $FreeBSD: doc/en_US.ISO8859-1/articles/cvs-freebsd/article.sgml,v 1.5 2002/04/10 12:54:25 kuriyama Exp $ @@ -183,7 +181,7 @@ checkoutlist - this files lists all files under control of CVS in this - directory. You should edit this to remove some FreeBSD specific + directory, apart from the standard ones created by cvs init. You should edit this to remove some FreeBSD-specific files. @@ -197,7 +195,7 @@ commitcheck - this script is invoked directly from CVS. It first checks if - the committer has access to the specified part of the tree, and + the committer has access to the specified part of the tree using cvs_acls.pl, and then runs commit_prep.pl for the various pre-commit checks. If those are OK, CVS will allow the commit to proceed. You should not have to touch @@ -207,7 +205,8 @@ commitinfo - this file is used by CVS to determine which script to run - before a commit. You should not have to touch this file. + before a commit—in this case commitcheck. + You should not have to touch this file. @@ -238,26 +237,32 @@ CVS to enable or disable keyword expansion, or whether a file should be considered binary. You can edit this as you wish. More information about this file - is available in the CVS manual. + is available in the CVS manual. + Note that the -t and -f + options don't work correctly with client/server + CVS edithook - this file is not used - any more, but kept for historic reasons. You should not have to - touch this file. + any more, but kept for historic reasons. You can safely + remove this file. editinfo - CVS uses this file for editor overrides. FreeBSD does not use this - functionality, as parsing the log message is done in the - verifymsg and logcheck - files. You should not have to touch this file. + functionality, as parsing the log message is done by + verifymsg and logcheck. + This is because the editinfo + functionality doesn't work properly with remote commits, or ones + that use the -m or -F + options. You should not have to touch this file. exclude - this file lists regular - expressions that are used to determine files which cannot contain a + expressions that are used by commit_prep.pl to determine files which cannot contain a revision header. In the FreeBSD setup, all files under revision control need to have a revision header (like $FreeBSD$). All filenames that match one of the lines @@ -274,26 +279,36 @@ logcheck script, and appends it to a log file in the repository for backup purposes. It also handles mailing out a message to an email address you provide (in - cfg_local.pm). You should not have to touch + cfg_local.pm). It hooks into + CVS via + loginfo. You should not have to touch this file. logcheck - this file parses the commit log message that committers provide, and attempts to sanitize it - somewhat. + somewhat. It hooks into CVS via + verifymsg. You should not have to touch + this file. This script depends on a local FreeBSD hack of CVS: this version reads the log message back in after this script has modified it. The stock version of - CVS apparently does not, which would - make this script useless. + CVS does not do this which makes + logcheck unable to clean up the log message, + although it is still able to check that it is syntactically + OK. CVS 1.11.2 can be configured to + have the same behaviour as FreeBSD's version by setting + RereadLogAfterVerify=always in the + config file. loginfo - this file is used by CVS to control where log - information is sent. You should not have to touch this + information is sent; log_accum.pl hooks + in here. You should not have to touch this file. @@ -315,7 +330,8 @@ options - this file is specific to - the FreeBSD version of CVS. It contains + the FreeBSD version of CVS, and is + also supported by the Debian version. It contains the keyword to expand in revision headers. You should alter this to match the keyword you specified in cfg_local.pm (if you use that feature, which @@ -324,7 +340,8 @@ rcsinfo - this file maps directories in - the repository to template files. By default, FreeBSD uses one + the repository to template files such as + rcstemplate. By default, FreeBSD uses one template for the whole repository. You can add others to this file if you wish. @@ -345,29 +362,33 @@ taginfo - this file maps tag operations - on repository directories to access control scripts. You should not + on repository directories to access control scripts such as + tagcheck. You should not have to touch this file. - unwrap - this script is needed to + unwrap - this script can be used to automatically unwrap binary files (see cvswrappers) on checkout. It is not used in the - current FreeBSD setup. You should not have to touch this + current FreeBSD setup because the functionality it hooks into + doesn't work well with remote commits. You should not have to touch this file. verifymsg - this file maps repository - directories to post processor scripts of log messages. You should + directories to post processor scripts of log messages such as + logcheck. You should not have to touch this file. - wrap - this script is needed to + wrap - this script can be used to automatically wrap binary files (see cvswrappers) on checkin. It is not used in the - current FreeBSD setup. You should not have to touch this + current FreeBSD setup because the functionality it hooks into + doesn't work well with remote commits. You should not have to touch this file. To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message