diff options
Diffstat (limited to 'gnu/usr.bin/cvs/src/options.h.in')
| -rw-r--r-- | gnu/usr.bin/cvs/src/options.h.in | 234 |
1 files changed, 124 insertions, 110 deletions
diff --git a/gnu/usr.bin/cvs/src/options.h.in b/gnu/usr.bin/cvs/src/options.h.in index 7cb58dcd944..0f6374b8b5a 100644 --- a/gnu/usr.bin/cvs/src/options.h.in +++ b/gnu/usr.bin/cvs/src/options.h.in @@ -16,65 +16,68 @@ */ /* - * CVS provides the most features when used in conjunction with the Version-5 - * release of RCS. Thus, it is the default. This also assumes that GNU diff - * Version-1.15 is being used as well -- you will have to configure your RCS - * V5 release separately to make this the case. If you do not have RCS V5 and - * GNU diff V1.15, comment out this define. You should not try mixing and - * matching other combinations of these tools. + * CVS provides the most features when used in conjunction with the + * Version-5 release of RCS. Thus, it is the default. This also + * assumes that GNU diff Version-1.15 is being used as well -- you + * will have to configure your RCS V5 release separately to make this + * the case. If you do not have RCS V5 and GNU diff V1.15, comment out + * this define. You should not try mixing and matching other + * combinations of these tools. */ #ifndef HAVE_RCS5 #define HAVE_RCS5 #endif /* - * If, before installing this version of CVS, you were running RCS V4 AND you - * are installing this CVS and RCS V5 and GNU diff 1.15 all at the same time, - * you should turn on the following define. It only exists to try to do - * reasonable things with your existing checked out files when you upgrade to - * RCS V5, since the keyword expansion formats have changed with RCS V5. + * If, before installing this version of CVS, you were running RCS V4 + * AND you are installing this CVS and RCS V5 and GNU diff 1.15 all at + * the same time, you should turn on the following define. It only + * exists to try to do reasonable things with your existing checked + * out files when you upgrade to RCS V5, since the keyword expansion + * formats have changed with RCS V5. * - * If you already have been running with RCS5, or haven't been running with CVS - * yet at all, or are sticking with RCS V4 for now, leave the commented out. + * If you already have been running with RCS5, or haven't been running + * with CVS yet at all, or are sticking with RCS V4 for now, leave the + * commented out. */ #ifndef HAD_RCS4 /* #define HAD_RCS4 */ #endif /* - * For portability and heterogeneity reasons, CVS is shipped by default using - * my own text-file version of the ndbm database library in the src/myndbm.c - * file. If you want better performance and are not concerned about - * heterogeneous hosts accessing your modules file, turn this option off. + * For portability and heterogeneity reasons, CVS is shipped by + * default using my own text-file version of the ndbm database library + * in the src/myndbm.c file. If you want better performance and are + * not concerned about heterogeneous hosts accessing your modules + * file, turn this option off. */ #ifndef MY_NDBM #define MY_NDBM #endif /* - * The "diff" program to execute when creating patch output. This "diff" - * must support the "-c" option for context diffing. Specify a full - * pathname if your site wants to use a particular diff. Note that unlike - * the diff used with RCS, you *must not* supply -a here (doing so will cause - * the server to generate patches which patch cannot handle in some cases). + * The "diff" program to execute when creating patch output. This + * "diff" must support the "-c" option for context diffing. Specify a + * full pathname if your site wants to use a particular diff. Note + * that unlike the diff used with RCS, you *must not* supply -a here + * (doing so will cause the server to generate patches which patch + * cannot handle in some cases). * * NOTE: this program is only used for the ``patch'' sub-command (and * for ``update'' if you are using the server). The other commands * use rcsdiff which will use whatever version of diff was specified * when rcsdiff was built on your system. */ - #ifndef DIFF #define DIFF "diff" #endif /* - * The "grep" program to execute when checking to see if a merged file had - * any conflicts. This "grep" must support a standard basic - * regular expression as an argument. Specify a full pathname if your site - * wants to use a particular grep. + * The "grep" program to execute when checking to see if a merged file + * had any conflicts. This "grep" must support a standard basic + * regular expression as an argument. Specify a full pathname if your + * site wants to use a particular grep. */ - #ifndef GREP #define GREP "grep" #endif @@ -89,13 +92,13 @@ #endif /* - * By default, RCS programs are executed with the shell or through execlp(), - * so the user's PATH environment variable is searched. If you'd like to - * bind all RCS programs to a certain directory (perhaps one not in most - * people's PATH) then set the default in RCSBIN_DFLT. Note that setting - * this here will cause all RCS programs to be executed from this directory, - * unless the user overrides the default with the RCSBIN environment variable - * or the "-b" option to CVS. + * By default, RCS programs are executed with the shell or through + * execlp(), so the user's PATH environment variable is searched. If + * you'd like to bind all RCS programs to a certain directory (perhaps + * one not in most people's PATH) then set the default in RCSBIN_DFLT. + * Note that setting this here will cause all RCS programs to be + * executed from this directory, unless the user overrides the default + * with the RCSBIN environment variable or the "-b" option to CVS. * * If you use the password-authenticating server, then you need to * make sure that the server can find the RCS programs to invoke them. @@ -104,12 +107,16 @@ * complete. But no actual shell is ever started by that user, so the * PATH environment variable may not contain the directory with the * RCS binaries, even though if that user logged in normally, PATH - * would include the directory. + * would include the directory. * * One way to solve this problem is to set RCSBIN_DFLT here. An * alternative is to make sure that root has the right directory in * its path already. Another, probably better alternative is to - * specify -b in /etc/inetd.conf. + * specify -b in /etc/inetd.conf. + * + * You may also have to set RCSBIN_DFLT here if there's no global + * start-up script run for users by rshd and your RCS programs are not + * in a directory in the default PATH assigned by rshd. * * This define should be either the empty string ("") or a full * pathname to the directory containing all the installed programs @@ -120,11 +127,22 @@ #endif /* - * The default editor to use, if one does not specify the "-e" option to cvs, - * or does not have an EDITOR environment variable. I set this to just "vi", - * and use the shell to find where "vi" actually is. This allows sites with - * /usr/bin/vi or /usr/ucb/vi to work equally well (assuming that your PATH - * is reasonable). + * The password-authenticating server creates a temporary checkout of + * the affected files. The variable TMPDIR_DFLT (or even better, the + * command-line option "-T" in the line for CVS in /etc/inetd.conf) + * can be used to specify the used directory. This directory will + * also be used for other temporary files. + */ +#ifndef TMPDIR_DFLT +#define TMPDIR_DFLT "/tmp" +#endif + +/* + * The default editor to use, if one does not specify the "-e" option + * to cvs, or does not have an EDITOR environment variable. I set + * this to just "vi", and use the shell to find where "vi" actually + * is. This allows sites with /usr/bin/vi or /usr/ucb/vi to work + * equally well (assuming that your PATH is reasonable). */ #ifndef EDITOR_DFLT #define EDITOR_DFLT "vi" @@ -147,22 +165,23 @@ * The cvs admin command is restricted to the members of the group * CVS_ADMIN_GROUP. If this group does not exist, all users are * allowed to run cvs admin. To disable the cvs admin for all users, - * create an empty group CVS_ADMIN_GROUP. To disable access control for - * cvs admin, comment out the define below. + * create an empty group CVS_ADMIN_GROUP. To disable access control + * for cvs admin, comment out the define below. */ #ifndef CVS_ADMIN_GROUP #define CVS_ADMIN_GROUP "cvsadmin" #endif /* - * The Repository file holds the path to the directory within the source - * repository that contains the RCS ,v files for each CVS working directory. - * This path is either a full-path or a path relative to CVSROOT. + * The Repository file holds the path to the directory within the + * source repository that contains the RCS ,v files for each CVS + * working directory. This path is either a full-path or a path + * relative to CVSROOT. * - * The only advantage that I can see to having a relative path is that One can - * change the physical location of the master source repository, change one's - * CVSROOT environment variable, and CVS will work without problems. I - * recommend using full-paths. + * The only advantage that I can see to having a relative path is that + * one can change the physical location of the master source + * repository, change one's CVSROOT environment variable, and CVS will + * work without problems. I recommend using full-paths. */ #ifndef RELATIVE_REPOS /* #define RELATIVE_REPOS */ @@ -170,25 +189,28 @@ /* * When committing or importing files, you must enter a log message. - * Normally, you can do this either via the -m flag on the command line or an - * editor will be started for you. If you like to use logging templates (the - * rcsinfo file within the $CVSROOT/CVSROOT directory), you might want to - * force people to use the editor even if they specify a message with -m. - * Enabling FORCE_USE_EDITOR will cause the -m message to be appended to the - * temp file when the editor is started. + * Normally, you can do this either via the -m flag on the command + * line or an editor will be started for you. If you like to use + * logging templates (the rcsinfo file within the $CVSROOT/CVSROOT + * directory), you might want to force people to use the editor even + * if they specify a message with -m. Enabling FORCE_USE_EDITOR will + * cause the -m message to be appended to the temp file when the + * editor is started. */ #ifndef FORCE_USE_EDITOR /* #define FORCE_USE_EDITOR */ #endif /* - * When locking the repository, some sites like to remove locks and assume - * the program that created them went away if the lock has existed for a long - * time. This used to be the default for previous versions of CVS. CVS now - * attempts to be much more robust, so lock files should not be left around - * by mistake. The new behaviour will never remove old locks (they must now - * be removed by hand). Enabling CVS_FUDGELOCKS will cause CVS to remove - * locks that are older than CVSLCKAGE seconds. + * When locking the repository, some sites like to remove locks and + * assume the program that created them went away if the lock has + * existed for a long time. This used to be the default for previous + * versions of CVS. CVS now attempts to be much more robust, so lock + * files should not be left around by mistake. The new behaviour will + * never remove old locks (they must now be removed by hand). + * Enabling CVS_FUDGELOCKS will cause CVS to remove locks that are + * older than CVSLCKAGE seconds. + * * Use of this option is NOT recommended. */ #ifndef CVS_FUDGELOCKS @@ -197,73 +219,65 @@ /* * When committing a permanent change, CVS and RCS make a log entry of - * who committed the change. If you are committing the change logged in - * as "root" (not under "su" or other root-priv giving program), CVS/RCS - * cannot determine who is actually making the change. + * who committed the change. If you are committing the change logged + * in as "root" (not under "su" or other root-priv giving program), + * CVS/RCS cannot determine who is actually making the change. * * As such, by default, CVS disallows changes to be committed by users - * logged in as "root". You can disable this option by commenting - * out the lines below. + * logged in as "root". You can disable this option by commenting out + * the lines below. */ #ifndef CVS_BADROOT #define CVS_BADROOT #endif /* - * The "cvs diff" command accepts all the single-character options that GNU - * diff (1.15) accepts. Except -D. GNU diff uses -D as a way to put - * cpp-style #define's around the output differences. CVS, by default, uses - * -D to specify a free-form date (like "cvs diff -D '1 week ago'"). If - * you would prefer that the -D option of "cvs diff" work like the GNU diff - * option, then comment out this define. + * Define this to enable the SETXID support. The way to use this is + * to create a group with no users in it (except perhaps cvs + * administrators), set the cvs executable to setgid that group, chown + * all the repository files to that group, and change all directory + * permissions in the repository to 770. The last person to modify a + * file will own it, but as long as directory permissions are set + * right that won't matter. You'll need a system which inherits file + * groups from the parent directory. I don't know how carefully this + * has been inspected for security holes. */ -#ifndef CVS_DIFFDATE -#define CVS_DIFFDATE -#endif - -/* Define this to enable the SETXID support. The way to use this is - to create a group with no users in it (except perhaps cvs - administrators), set the cvs executable to setgid that group, chown - all the repository files to that group, and change all directory - permissions in the repository to 770. The last person to modify a - file will own it, but as long as directory permissions are set - right that won't matter. You'll need a system which inherits file - groups from the parent directory. I don't know how carefully this - has been inspected for security holes. */ - #ifndef SETXID_SUPPORT /* #define SETXID_SUPPORT */ #endif -/* Should we build the password-authenticating client? Whether to - include the password-authenticating _server_, on the other hand, is - set in config.h. */ +/* + * Should we build the password-authenticating client? Whether to + * include the password-authenticating _server_, on the other hand, is + * set in config.h. + */ +#ifdef CLIENT_SUPPORT #define AUTH_CLIENT_SUPPORT 1 +#endif /* - * If you are working with a large remote repository and a 'cvs checkout' is - * swamping your network and memory, define these to enable flow control. - * You will end up with even less guarantees of a consistant checkout, - * but that may be better than no checkout at all. The master server process - * will monitor how far it is getting behind, if it reaches the high water - * mark, it will signal the child process to stop generating data when - * convenient (ie: no locks are held, currently at the beginning of a - * new directory). Once the buffer has drained sufficiently to reach the - * low water mark, it will be signalled to start again. - * -- EXPERIMENTAL! -- A better solution may be in the works. - * You may override the default hi/low watermarks here too. + * If you are working with a large remote repository and a 'cvs + * checkout' is swamping your network and memory, define these to + * enable flow control. You will end up with even less probability of + * a consistent checkout (see Concurrency in cvs.texinfo), but CVS + * doesn't try to guarantee that anyway. The master server process + * will monitor how far it is getting behind, if it reaches the high + * water mark, it will signal the child process to stop generating + * data when convenient (ie: no locks are held, currently at the + * beginning of a new directory). Once the buffer has drained + * sufficiently to reach the low water mark, it will be signalled to + * start again. You may override the default hi/low watermarks here + * too. */ -#ifndef SERVER_FLOWCONTROL -/* #define SERVER_FLOWCONTROL */ -/* #define SERVER_HI_WATER (2 * 1024 * 1024) */ -/* #define SERVER_LO_WATER (1 * 1024 * 1024) */ -#endif +#define SERVER_FLOWCONTROL +#define SERVER_HI_WATER (2 * 1024 * 1024) +#define SERVER_LO_WATER (1 * 1024 * 1024) /* End of CVS configuration section */ /* - * Externs that are included in libc, but are used frequently enough to - * warrant defining here. + * Externs that are included in libc, but are used frequently enough + * to warrant defining here. */ #ifndef STDC_HEADERS extern void exit (); |