Date: Thu, 25 Jul 2002 15:00:44 +0100 From: Tony Finch <dot@dotat.at> To: Giorgos Keramidas <keramida@FreeBSD.org>, doc@freebsd.org Cc: cvs@freebsd.org, dwmalone@freebsd.org Subject: Re: CVSROOT documentation patch Message-ID: <20020725150044.H8886@chiark.greenend.org.uk> In-Reply-To: <20020720154611.A1296@chiark.greenend.org.uk>; from dot@dotat.at on Sat, Jul 20, 2002 at 03:46:11PM %2B0100 References: <E17VCWe-000L8c-00@cyan.csi.cam.ac.uk> <20020718163457.D32457@chiark.greenend.org.uk> <20020719202612.B8238@chiark.greenend.org.uk> <20020719204817.C8238@chiark.greenend.org.uk> <20020720154611.A1296@chiark.greenend.org.uk>
next in thread | previous in thread | raw e-mail | index | archive | help
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 <dot@dotat.at> 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 @@ <holder role="mailto:stijn@win.tue.nl">Stijn Hoop</holder> </copyright> - <pubdate role="rcs">$Date$</pubdate> - <releaseinfo>$FreeBSD: doc/en_US.ISO8859-1/articles/cvs-freebsd/article.sgml,v 1.5 2002/04/10 12:54:25 kuriyama Exp $</releaseinfo> <abstract> @@ -183,7 +181,7 @@ <listitem> <para><filename>checkoutlist</filename> - this files lists all files under control of <application>CVS</application> in this - directory. You should edit this to remove some FreeBSD specific + directory, apart from the standard ones created by <literal>cvs init</literal>. You should edit this to remove some FreeBSD-specific files.</para> </listitem> @@ -197,7 +195,7 @@ <listitem> <para><filename>commitcheck</filename> - this script is invoked directly from <application>CVS</application>. 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 <filename>cvs_acls.pl</filename>, and then runs <filename>commit_prep.pl</filename> for the various pre-commit checks. If those are OK, <application>CVS</application> will allow the commit to proceed. You should not have to touch @@ -207,7 +205,8 @@ <listitem> <para><filename>commitinfo</filename> - this file is used by <application>CVS</application> to determine which script to run - before a commit. You should not have to touch this file.</para> + before a commit—in this case <filename>commitcheck</filename>. + You should not have to touch this file.</para> </listitem> <listitem> @@ -238,26 +237,32 @@ <application>CVS</application> 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 <application>CVS</application> manual.</para> + is available in the <application>CVS</application> manual. + Note that the <literal>-t</literal> and <literal>-f</literal> + options don't work correctly with client/server + <application>CVS</application></para> </listitem> <listitem> <para><filename>edithook</filename> - this file is not used - any more, but kept for historic reasons. You should not have to - touch this file.</para> + any more, but kept for historic reasons. You can safely + remove this file.</para> </listitem> <listitem> <para><filename>editinfo</filename> - <application>CVS</application> uses this file for editor overrides. FreeBSD does not use this - functionality, as parsing the log message is done in the - <filename>verifymsg</filename> and <filename>logcheck</filename> - files. You should not have to touch this file.</para> + functionality, as parsing the log message is done by + <filename>verifymsg</filename> and <filename>logcheck</filename>. + This is because the <filename>editinfo</filename> + functionality doesn't work properly with remote commits, or ones + that use the <literal>-m</literal> or <literal>-F</literal> + options. You should not have to touch this file.</para> </listitem> <listitem> <para><filename>exclude</filename> - this file lists regular - expressions that are used to determine files which cannot contain a + expressions that are used by <filename>commit_prep.pl</filename> 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 @@ <filename>logcheck</filename> 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 - <filename>cfg_local.pm</filename>). You should not have to touch + <filename>cfg_local.pm</filename>). It hooks into + <application>CVS</application> via + <filename>loginfo</filename>. You should not have to touch this file.</para> </listitem> <listitem> <para><filename>logcheck</filename> - this file parses the commit log message that committers provide, and attempts to sanitize it - somewhat.</para> + somewhat. It hooks into <application>CVS</application> via + <filename>verifymsg</filename>. You should not have to touch + this file.</para> <note><para>This script depends on a local FreeBSD hack of <application>CVS</application>: this version reads the log message back in after this script has modified it. The stock version of - <application>CVS</application> apparently does not, which would - make this script useless.</para></note> + <application>CVS</application> does not do this which makes + <filename>logcheck</filename> unable to clean up the log message, + although it is still able to check that it is syntactically + OK. <application>CVS</application> 1.11.2 can be configured to + have the same behaviour as FreeBSD's version by setting + <literal>RereadLogAfterVerify=always</literal> in the + <filename>config</filename> file.</para></note> </listitem> <listitem> <para><filename>loginfo</filename> - this file is used by <application>CVS</application> to control where log - information is sent. You should not have to touch this + information is sent; <filename>log_accum.pl</filename> hooks + in here. You should not have to touch this file.</para> </listitem> @@ -315,7 +330,8 @@ <listitem> <para><filename>options</filename> - this file is specific to - the FreeBSD version of <application>CVS</application>. It contains + the FreeBSD version of <application>CVS</application>, 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 <filename>cfg_local.pm</filename> (if you use that feature, which @@ -324,7 +340,8 @@ <listitem> <para><filename>rcsinfo</filename> - this file maps directories in - the repository to template files. By default, FreeBSD uses one + the repository to template files such as + <filename>rcstemplate</filename>. By default, FreeBSD uses one template for the whole repository. You can add others to this file if you wish.</para> </listitem> @@ -345,29 +362,33 @@ <listitem> <para><filename>taginfo</filename> - this file maps tag operations - on repository directories to access control scripts. You should not + on repository directories to access control scripts such as + <filename>tagcheck</filename>. You should not have to touch this file.</para> </listitem> <listitem> - <para><filename>unwrap</filename> - this script is needed to + <para><filename>unwrap</filename> - this script can be used to automatically <quote>unwrap</quote> binary files (see <filename>cvswrappers</filename>) 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.</para> </listitem> <listitem> <para><filename>verifymsg</filename> - this file maps repository - directories to post processor scripts of log messages. You should + directories to post processor scripts of log messages such as + <filename>logcheck</filename>. You should not have to touch this file.</para> </listitem> <listitem> - <para><filename>wrap</filename> - this script is needed to + <para><filename>wrap</filename> - this script can be used to automatically <quote>wrap</quote> binary files (see <filename>cvswrappers</filename>) 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.</para> </listitem> </itemizedlist> To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20020725150044.H8886>