Date: Fri, 19 Jul 2002 20:48:17 +0100 From: Tony Finch <dot@dotat.at> To: cvs@freebsd.org, doc@freebsd.org Cc: dot@dotat.at, dwmalone@freebsd.org Subject: CVSROOT documentation patch Message-ID: <20020719204817.C8238@chiark.greenend.org.uk> In-Reply-To: <20020719202612.B8238@chiark.greenend.org.uk>; from dot@dotat.at on Fri, Jul 19, 2002 at 08:26:12PM %2B0100 References: <E17VCWe-000L8c-00@cyan.csi.cam.ac.uk> <20020718163457.D32457@chiark.greenend.org.uk> <20020719202612.B8238@chiark.greenend.org.uk>
next in thread | previous in thread | raw e-mail | index | archive | help
This is an update to the CVSROOT documentation. It removes an unexpanded $Date$ keyword, adds more crossreferences between the various CVSROOT files, adds notes about unused functionality that's broken with remote commits, and explains some compatibility issues related to local FreeBSD CVS hacks in more detail. Should I commit it myself or leave it to a doc committer? Tony. -- f.a.n.finch <dot@dotat.at> http://dotat.at/ NORTH UTSIRE SOUTH UTSIRE: NORTH OR NORTHWEST 3 OR 4, OCCASIONALLY 5. FAIR. GOOD. Index: article.sgml =================================================================== RCS file: /home/ncvs/doc/en_US.ISO8859-1/articles/cvs-freebsd/article.sgml,v retrieving revision 1.5 diff -u -r1.5 article.sgml --- article.sgml 10 Apr 2002 12:54:25 -0000 1.5 +++ article.sgml 19 Jul 2002 19:36:21 -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,8 +181,9 @@ <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 - files.</para> + directory, apart from the standard ones created by + <literal>cvs init</literal>. You should edit this to + remove some FreeBSD specific files.</para> </listitem> <listitem> @@ -196,18 +195,20 @@ <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 - 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 - this file.</para> + directly from <application>CVS</application>. It first checks + if 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 this + file.</para> </listitem> <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,13 +239,16 @@ <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> @@ -252,49 +256,56 @@ 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> + files. 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 - 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 - in this file are exempted from this check. You should add - expressions to this file as you checkin files that cannot have a - revision header. For the purpose of installing the scripts, it - may be best to exclude <filename>CVSROOT/</filename> from header - checks.</para> + 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 in this file are exempted from this check. + You should add expressions to this file as you checkin files that + cannot have a revision header. For the purpose of installing the + scripts, it may be best to exclude <filename>CVSROOT/</filename> + from header checks.</para> </listitem> <listitem> - <para><filename>log_accum.pl</filename> - this is a script that - takes the log message as provided by the - <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 - this file.</para> - </listitem> + <para><filename>log_accum.pl</filename> - this is a script that takes + the log message as provided by the <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>). 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.</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 - file.</para> + information is sent; <filename>log_accum.pl</filename> hooks + in here. You should not have to touch this file.</para> </listitem> <listitem> @@ -315,7 +326,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 @@ -323,10 +335,11 @@ </listitem> <listitem> - <para><filename>rcsinfo</filename> - this file maps directories in - the repository to template files. By default, FreeBSD uses one - template for the whole repository. You can add others to this file - if you wish.</para> + <para><filename>rcsinfo</filename> - this file maps directories + in 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> <listitem> @@ -345,30 +358,34 @@ <listitem> <para><filename>taginfo</filename> - this file maps tag operations - on repository directories to access control scripts. You should not - have to touch this file.</para> + 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 - file.</para> + 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 - not have to touch this file.</para> + 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 - file.</para> + 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> </sect2> 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?20020719204817.C8238>