Geek Gadgets 1

home *** CD-ROM | disk | FTP | other *** search

/ Geek Gadgets 1 / ADE-1.bin / ade-dist / cvs-1.8.7-bin.lha / info / cvs.info-3 < prev next >

Wrap

GNU Info File | 1996-10-12 | 48.6 KB | 1,254 lines

This is Info file cvs.info, produced by Makeinfo-1.64 from the input file /ade-src/fsf/cvs/doc/cvs.texinfo. Copyright (C) 1992, 1993 Signum Support AB Copyright (C) 1993, 1994 Free Software Foundation, Inc. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies. Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided also that the section entitled "GNU General Public License" is included exactly as in the original, and provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one. Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that the section entitled "GNU General Public License" and this permission notice may be included in translations approved by the Free Software Foundation instead of in the original English. File: cvs.info, Node: Inside, Next: Rename by copying, Prev: Outside, Up: Moving files Moving the history file ======================= This method is more dangerous, since it involves moving files inside the repository. Read this entire section before trying it out! $ cd $CVSROOT/MODULE $ mv OLD,v NEW,v Advantages: * The log of changes is maintained intact. * The revision numbers are not affected. Disadvantages: * Old releases of the module cannot easily be fetched from the repository. (The file will show up as NEW even in revisions from the time before it was renamed). * There is no log information of when the file was renamed. * Nasty things might happen if someone accesses the history file while you are moving it. Make sure no one else runs any of the CVS commands while you move it. File: cvs.info, Node: Rename by copying, Prev: Inside, Up: Moving files Copying the history file ======================== This way also involves direct modifications to the repository. It is safe, but not without drawbacks. # Copy the RCS file inside the repository $ cd $CVSROOT/MODULE $ cp OLD,v NEW,v # Remove the old file $ cd ~/MODULE $ rm OLD $ cvs remove OLD $ cvs commit OLD # Remove all tags from NEW $ cvs update NEW $ cvs log NEW # Remember the tag names $ cvs tag -d TAG1 $ cvs tag -d TAG2 ... By removing the tags you will be able to check out old revisions of the module. Advantages: * Checking out old revisions works correctly, as long as you use `-rTAG' and not `-DDATE' to retrieve the revisions. * The log of changes is maintained intact. * The revision numbers are not affected. Disadvantages: * You cannot easily see the history of the file across the rename. * Unless you use the `-r rev' (*note commit options::.) flag when NEW is committed its revision numbers will start at 1.0 again. File: cvs.info, Node: Moving directories, Next: History browsing, Prev: Moving files, Up: Top Moving and renaming directories ******************************* If you want to be able to retrieve old versions of the module, you must move each file in the directory with the CVS commands. *Note Outside::. The old, empty directory will remain inside the repository, but it will not appear in your workspace when you check out the module in the future. If you really want to rename or delete a directory, you can do it like this: 1. Inform everyone who has a copy of the module that the directory will be renamed. They should commit all their changes, and remove their working copies of the module, before you take the steps below. 2. Rename the directory inside the repository. $ cd $CVSROOT/MODULE $ mv OLD-DIR NEW-DIR 3. Fix the CVS administrative files, if necessary (for instance if you renamed an entire module). 4. Tell everyone that they can check out the module and continue working. If someone had a working copy of the module the CVS commands will cease to work for him, until he removes the directory that disappeared inside the repository. It is almost always better to move the files in the directory instead of moving the directory. If you move the directory you are unlikely to be able to retrieve old releases correctly, since they probably depend on the name of the directories. File: cvs.info, Node: History browsing, Next: Keyword substitution, Prev: Moving directories, Up: Top History browsing **************** Once you have used CVS to store a version control history--what files have changed when, how, and by whom, there are a variety of mechanisms for looking through the history. * Menu: * log messages:: Log messages * history database:: The history database * user-defined logging:: User-defined logging * annotate:: What revision modified each line of a file? File: cvs.info, Node: log messages, Next: history database, Up: History browsing Log messages ============ Whenever you commit a file you specify a log message. To look through the log messages which have been specified for every revision which has been committed, use the `cvs log' command (*note log::.). File: cvs.info, Node: history database, Next: user-defined logging, Prev: log messages, Up: History browsing The history database ==================== You can use the history file (*note history file::.) to log various CVS actions. To retrieve the information from the history file, use the `cvs history' command (*note history::.). File: cvs.info, Node: user-defined logging, Next: annotate, Prev: history database, Up: History browsing User-defined logging ==================== You can customize CVS to log various kinds of actions, in whatever manner you choose. These mechanisms operate by executing a script at various times. The script might append a message to a file listing the information and the programmer who created it, or send mail to a group of developers, or, perhaps, post a message to a particular newsgroup. To log commits, use the `loginfo' file (*note loginfo::.). To log commits, checkouts, exports, and tags, respectively, you can also use the `-i', `-o', `-e', and `-t' options in the modules file. For a more flexible way of giving notifications to various users, which requires less in the way of keeping centralized scripts up to date, use the `cvs watch add' command (*note Getting Notified::.); this command is useful even if you are not using `cvs watch on'. The `taginfo' file defines programs to execute when someone executes a `tag' or `rtag' command. The `taginfo' file has the standard form for administrative files (*note Administrative files::.), where each line is a regular expression followed by a command to execute. The arguments passed to the command are, in order, the TAGNAME, OPERATION (`add' for `tag', `mov' for `tag -F', and `del' for `tag -d'), REPOSITORY, and any remaining are pairs of FILENAME REVISION. A non-zero exit of the filter program will cause the tag to be aborted. File: cvs.info, Node: annotate, Prev: user-defined logging, Up: History browsing Annotate command ================ - Command: cvs annotate [`-lf'] [`-r rev'|`-D date'] FILES ... For each file in FILES, print the head revision of the trunk, together with information on the last modification for each line. For example: $ cvs annotate ssfile Annotations for ssfile *************** 1.1 (mary 27-Mar-96): ssfile line 1 1.2 (joe 28-Mar-96): ssfile line 2 The file `ssfile' currently contains two lines. The `ssfile line 1' line was checked in by `mary' on March 27. Then, on March 28, `joe' added a line `ssfile line 2', without modifying the `ssfile line 1' line. This report doesn't tell you anything about lines which have been deleted or replaced; you need to use `cvs diff' for that (*note diff::.). These standard options are available with `annotate' (*note Common options::., for a complete description of them): `-D DATE' Annotate the most recent revision no later than DATE. `-f' Only useful with the `-D DATE' or `-r TAG' flags. If no matching revision is found, annotate the most recent revision (instead of ignoring the file). `-l' Local; run only in current working directory. *Note Recursive behavior::. `-r TAG' Annotate revision TAG. File: cvs.info, Node: Keyword substitution, Next: Binary files, Prev: History browsing, Up: Top Keyword substitution ******************** As long as you edit source files inside your working copy of a module you can always find out the state of your files via `cvs status' and `cvs log'. But as soon as you export the files from your development environment it becomes harder to identify which revisions they are. RCS uses a mechanism known as "keyword substitution" (or "keyword expansion") to help identifying the files. Embedded strings of the form `$KEYWORD$' and `$KEYWORD:...$' in a file are replaced with strings of the form `$KEYWORD:VALUE$' whenever you obtain a new revision of the file. * Menu: * Keyword list:: RCS Keywords * Using keywords:: Using keywords * Avoiding substitution:: Avoiding substitution * Substitution modes:: Substitution modes * Log keyword:: Problems with the $Log$ keyword. File: cvs.info, Node: Keyword list, Next: Using keywords, Up: Keyword substitution RCS Keywords ============ This is a list of the keywords that RCS currently (in release 5.6.0.1) supports: `$Author$' The login name of the user who checked in the revision. `$Date$' The date and time (UTC) the revision was checked in. `$Header$' A standard header containing the full pathname of the RCS file, the revision number, the date (UTC), the author, the state, and the locker (if locked). Files will normally never be locked when you use CVS. `$Id$' Same as `$Header$', except that the RCS filename is without a path. `$Name$' Tag name used to check out this file. `$Locker$' The login name of the user who locked the revision (empty if not locked, and thus almost always useless when you are using CVS). `$Log$' The log message supplied during commit, preceded by a header containing the RCS filename, the revision number, the author, and the date (UTC). Existing log messages are *not* replaced. Instead, the new log message is inserted after `$Log:...$'. Each new line is prefixed with a "comment leader" which RCS guesses from the file name extension. It can be changed with `cvs admin -c'. *Note admin options::. This keyword is useful for accumulating a complete change log in a source file, but for several reasons it can be problematic. *Note Log keyword::. `$RCSfile$' The name of the RCS file without a path. `$Revision$' The revision number assigned to the revision. `$Source$' The full pathname of the RCS file. `$State$' The state assigned to the revision. States can be assigned with `cvs admin -s'--*Note admin options::. File: cvs.info, Node: Using keywords, Next: Avoiding substitution, Prev: Keyword list, Up: Keyword substitution Using keywords ============== To include a keyword string you simply include the relevant text string, such as `$Id$', inside the file, and commit the file. CVS will automatically expand the string as part of the commit operation. It is common to embed `$Id$' string in the C source code. This example shows the first few lines of a typical file, after keyword substitution has been performed: static char *rcsid="$Id: samp.c,v 1.5 1993/10/19 14:57:32 ceder Exp $"; /* The following lines will prevent `gcc' version 2.X from issuing an "unused variable" warning. */ #if __GNUC__ == 2 #define USE(var) static void * use_##var = (&use_##var, (void *) &var) USE (rcsid); #endif Even though a clever optimizing compiler could remove the unused variable `rcsid', most compilers tend to include the string in the binary. Some compilers have a `#pragma' directive to include literal text in the binary. The `ident' command (which is part of the RCS package) can be used to extract keywords and their values from a file. This can be handy for text files, but it is even more useful for extracting keywords from binary files. $ ident samp.c samp.c: $Id: samp.c,v 1.5 1993/10/19 14:57:32 ceder Exp $ $ gcc samp.c $ ident a.out a.out: $Id: samp.c,v 1.5 1993/10/19 14:57:32 ceder Exp $ SCCS is another popular revision control system. It has a command, `what', which is very similar to `ident' and used for the same purpose. Many sites without RCS have SCCS. Since `what' looks for the character sequence `@(#)' it is easy to include keywords that are detected by either command. Simply prefix the RCS keyword with the magic SCCS phrase, like this: static char *id="@(#) $Id: ab.c,v 1.5 1993/10/19 14:57:32 ceder Exp $"; File: cvs.info, Node: Avoiding substitution, Next: Substitution modes, Prev: Using keywords, Up: Keyword substitution Avoiding substitution ===================== Keyword substitution has its disadvantages. Sometimes you might want the literal text string `$Author$' to appear inside a file without RCS interpreting it as a keyword and expanding it into something like `$Author: ceder $'. There is unfortunately no way to selectively turn off keyword substitution. You can use `-ko' (*note Substitution modes::.) to turn off keyword substitution entirely. In many cases you can avoid using RCS keywords in the source, even though they appear in the final product. For example, the source for this manual contains `$@asis{}Author$' whenever the text `$Author$' should appear. In `nroff' and `troff' you can embed the null-character `\&' inside the keyword for a similar effect. File: cvs.info, Node: Substitution modes, Next: Log keyword, Prev: Avoiding substitution, Up: Keyword substitution Substitution modes ================== Each file has a stored default substitution mode, and each working directory copy of a file also has a substitution mode. The former is set by the `-k' option to `cvs add' and `cvs admin'; the latter is set by the -k or -A options to `cvs checkout' or `cvs update'. `cvs diff' also has a `-k' option. For some examples, *Note Binary files::. The modes available are: `-kkv' Generate keyword strings using the default form, e.g. `$Revision: 5.7 $' for the `Revision' keyword. `-kkvl' Like `-kkv', except that a locker's name is always inserted if the given revision is currently locked. This option is normally not useful when CVS is used. `-kk' Generate only keyword names in keyword strings; omit their values. For example, for the `Revision' keyword, generate the string `$Revision$' instead of `$Revision: 5.7 $'. This option is useful to ignore differences due to keyword substitution when comparing different revisions of a file. `-ko' Generate the old keyword string, present in the working file just before it was checked in. For example, for the `Revision' keyword, generate the string `$Revision: 1.1 $' instead of `$Revision: 5.7 $' if that is how the string appeared when the file was checked in. `-kb' Like `-ko', but also inhibit conversion of line endings between the canonical form in which they are stored in the repository (linefeed only), and the form appropriate to the operating system in use on the client. For systems, like unix, which use linefeed only to terminate lines, this is the same as `-ko'. For more information on binary files, see *Note Binary files::. `-kv' Generate only keyword values for keyword strings. For example, for the `Revision' keyword, generate the string `5.7' instead of `$Revision: 5.7 $'. This can help generate files in programming languages where it is hard to strip keyword delimiters like `$Revision: $' from a string. However, further keyword substitution cannot be performed once the keyword names are removed, so this option should be used with care. One often would like to use `-kv' with `cvs export'--*note export::.. But be aware that doesn't handle an export containing binary files correctly. File: cvs.info, Node: Log keyword, Prev: Substitution modes, Up: Keyword substitution Problems with the $Log$ keyword. ================================ The `$Log$' keyword is somewhat controversial. As long as you are working on your development system the information is easily accessible even if you do not use the `$Log$' keyword--just do a `cvs log'. Once you export the file the history information might be useless anyhow. A more serious concern is that RCS is not good at handling `$Log$' entries when a branch is merged onto the main trunk. Conflicts often result from the merging operation. People also tend to "fix" the log entries in the file (correcting spelling mistakes and maybe even factual errors). If that is done the information from `cvs log' will not be consistent with the information inside the file. This may or may not be a problem in real life. It has been suggested that the `$Log$' keyword should be inserted *last* in the file, and not in the files header, if it is to be used at all. That way the long list of change messages will not interfere with everyday source file browsing. File: cvs.info, Node: Binary files, Next: Revision management, Prev: Keyword substitution, Up: Top Handling binary files ********************* There are two issues with using CVS to store binary files. The first is that CVS by default convert line endings between the canonical form in which they are stored in the repository (linefeed only), and the form appropriate to the operating system in use on the client (for example, carriage return followed by line feed for Windows NT). The second is that a binary file might happen to contain data which looks like a keyword (*note Keyword substitution::.), so keyword expansion must be turned off. The `-kb' option available with some CVS commands insures that neither line ending conversion nor keyword expansion will be done. If you are using an old version of RCS without this option, and you are using an operating system, such as unix, which terminates lines with linefeeds only, you can use `-ko' instead; if you are on another operating system, upgrade to a version of RCS, such as 5.7 or later, which supports `-kb'. Here is an example of how you can create a new file using the `-kb' flag: $ echo '$Id$' > kotest $ cvs add -kb -m"A test file" kotest $ cvs ci -m"First checkin; contains a keyword" kotest If a file accidentally gets added without `-kb', one can use the `cvs admin' command to recover. For example: $ echo '$Id$' > kotest $ cvs add -m"A test file" kotest $ cvs ci -m"First checkin; contains a keyword" kotest $ cvs admin -kb kotest $ cvs update -A kotest $ cvs commit -m "make it binary" kotest # For non-unix systems When you check in the file `kotest' the keywords are expanded. (Try the above example, and do a `cat kotest' after every command). The `cvs admin -kb' command sets the default keyword substitution method for this file, but it does not alter the working copy of the file that you have. The easiest way to get the unexpanded version of `kotest' is `cvs update -A'. If you need to cope with line endings (that is, you are using a CVS client on a non-unix system), then you need to check in a new copy of the file, as shown by the `cvs commit' command above. However, in using `cvs admin -k' to change the keyword expansion, be aware that the keyword expansion mode is not version controlled. This means that, for example, that if you have a text file in old releases, and a binary file with the same name in new releases, CVS provides no way to check out the file in text or binary mode depending on what version you are checking out. There is no good workaround for this problem. You can also set a default for whether `cvs add' and `cvs import' treat a file as binary based on its name; for example you could say that files who names end in `.exe' are binary. *Note Wrappers::. File: cvs.info, Node: Revision management, Next: Invoking CVS, Prev: Binary files, Up: Top Revision management ******************* If you have read this far, you probably have a pretty good grasp on what CVS can do for you. This chapter talks a little about things that you still have to decide. If you are doing development on your own using CVS you could probably skip this chapter. The questions this chapter takes up become more important when more than one person is working in a repository. * Menu: * When to commit:: Some discussion on the subject File: cvs.info, Node: When to commit, Up: Revision management When to commit? =============== Your group should decide which policy to use regarding commits. Several policies are possible, and as your experience with CVS grows you will probably find out what works for you. If you commit files too quickly you might commit files that do not even compile. If your partner updates his working sources to include your buggy file, he will be unable to compile the code. On the other hand, other persons will not be able to benefit from the improvements you make to the code if you commit very seldom, and conflicts will probably be more common. It is common to only commit files after making sure that they can be compiled. Some sites require that the files pass a test suite. Policies like this can be enforced using the commitinfo file (*note commitinfo::.), but you should think twice before you enforce such a convention. By making the development environment too controlled it might become too regimented and thus counter-productive to the real goal, which is to get software written. File: cvs.info, Node: Invoking CVS, Next: Administrative files, Prev: Revision management, Up: Top Reference manual for CVS commands ********************************* This appendix describes how to invoke CVS, and describes in detail those subcommands of CVS which are not fully described elsewhere. To look up a particular subcommand, see *Note Index::. * Menu: * Structure:: Overall structure of CVS commands * ~/.cvsrc:: Default options with the ~/.csvrc file * Global options:: Options you give to the left of cvs_command * Common options:: Options you give to the right of cvs_command * add:: Add a new file/directory to the repository * admin:: Administration front end for rcs * checkout:: Checkout sources for editing * commit:: Check files into the repository * diff:: Run diffs between revisions * export:: Export sources from CVS, similar to checkout * history:: Show status of files and users * import:: Import sources into CVS, using vendor branches * log:: Print out 'rlog' information for files * rdiff:: 'patch' format diffs between releases * release:: Indicate that a Module is no longer in use * rtag:: Add a tag to a module * status:: Status info on the revisions * tag:: Add a tag to checked out version * update:: Bring work tree in sync with repository File: cvs.info, Node: Structure, Next: ~/.cvsrc, Up: Invoking CVS Overall structure of CVS commands ================================= The overall format of all CVS commands is: cvs [ cvs_options ] cvs_command [ command_options ] [ command_args ] `cvs' The name of the CVS program. `cvs_options' Some options that affect all sub-commands of CVS. These are described below. `cvs_command' One of several different sub-commands. Some of the commands have aliases that can be used instead; those aliases are noted in the reference manual for that command. There are only two situations where you may omit `cvs_command': `cvs -H' elicits a list of available commands, and `cvs -v' displays version information on CVS itself. `command_options' Options that are specific for the command. `command_args' Arguments to the commands. There is unfortunately some confusion between `cvs_options' and `command_options'. `-l', when given as a `cvs_option', only affects some of the commands. When it is given as a `command_option' is has a different meaning, and is accepted by more commands. In other words, do not take the above categorization too seriously. Look at the documentation instead. File: cvs.info, Node: ~/.cvsrc, Next: Global options, Prev: Structure, Up: Invoking CVS Default options and the ~/.cvsrc file ===================================== There are some `command_options' that are used so often that you might have set up an alias or some other means to make sure you always specify that option. One example (the one that drove the implementation of the .cvsrc support, actually) is that many people find the default output of the `diff' command to be very hard to read, and that either context diffs or unidiffs are much easier to understand. The `~/.cvsrc' file is a way that you can add default options to `cvs_commands' within cvs, instead of relying on aliases or other shell scripts. The format of the `~/.cvsrc' file is simple. The file is searched for a line that begins with the same name as the `cvs_command' being executed. If a match is found, then the remainder of the line is split up (at whitespace characters) into separate options and added to the command arguments *before* any options from the command line. If a command has two names (e.g., `checkout' and `co'), the official name, not necessarily the one used on the command line, will be used to match against the file. So if this is the contents of the user's `~/.cvsrc' file: log -N diff -u update -P co -P the command `cvs checkout foo' would have the `-P' option added to the arguments, as well as `cvs co foo'. With the example file above, the output from `cvs diff foobar' will be in unidiff format. `cvs diff -c foobar' will provide context diffs, as usual. Getting "old" format diffs would be slightly more complicated, because `diff' doesn't have an option to specify use of the "old" format, so you would need `cvs -f diff foobar'. In place of the command name you can use `cvs' to specify global options (*note Global options::.). For example the following line in `.cvsrc' cvs -z6 causes CVS to use compression level 6 File: cvs.info, Node: Global options, Next: Common options, Prev: ~/.cvsrc, Up: Invoking CVS Global options ============== The available `cvs_options' (that are given to the left of `cvs_command') are: `-b BINDIR' Use BINDIR as the directory where RCS programs are located. Overrides the setting of the `$RCSBIN' environment variable and any precompiled directory. This parameter should be specified as an absolute pathname. `-d CVS_ROOT_DIRECTORY' Use CVS_ROOT_DIRECTORY as the root directory pathname of the repository. Overrides the setting of the `$CVSROOT' environment variable. *Note Repository::. `-e EDITOR' Use EDITOR to enter revision log information. Overrides the setting of the `$CVSEDITOR' and `$EDITOR' environment variables. `-f' Do not read the `~/.cvsrc' file. This option is most often used because of the non-orthogonality of the CVS option set. For example, the `cvs log' option `-N' (turn off display of tag names) does not have a corresponding option to turn the display on. So if you have `-N' in the `~/.cvsrc' entry for `log', you may need to use `-f' to show the tag names. `-H' Display usage information about the specified `cvs_command' (but do not actually execute the command). If you don't specify a command name, `cvs -H' displays a summary of all the commands available. `-l' Do not log the cvs_command in the command history (but execute it anyway). *Note history::, for information on command history. `-n' Do not change any files. Attempt to execute the `cvs_command', but only to issue reports; do not remove, update, or merge any existing files, or create any new files. `-Q' Cause the command to be really quiet; the command will only generate output for serious problems. `-q' Cause the command to be somewhat quiet; informational messages, such as reports of recursion through subdirectories, are suppressed. `-r' Make new working files files read-only. Same effect as if the `$CVSREAD' environment variable is set (*note Environment variables::.). The default is to make working files writable, unless watches are on (*note Watches::.). `-s VARIABLE=VALUE' Set a user variable (*note Variables::.). `-t' Trace program execution; display messages showing the steps of CVS activity. Particularly useful with `-n' to explore the potential impact of an unfamiliar command. `-v' Display version and copyright information for CVS. `-w' Make new working files read-write. Overrides the setting of the `$CVSREAD' environment variable. Files are created read-write by default, unless `$CVSREAD' is set or `-r' is given. `-x' Encrypt all communication between the client and the server. Only has an effect on the CVS client. As of this writing, this is only implemented when using a Kerberos connection (*note Kerberos authenticated::.). `-z GZIP-LEVEL' Set the compression level. Only has an effect on the CVS client. File: cvs.info, Node: Common options, Next: add, Prev: Global options, Up: Invoking CVS Common command options ====================== This section describes the `command_options' that are available across several CVS commands. These options are always given to the right of `cvs_command'. Not all commands support all of these options; each option is only supported for commands where it makes sense. However, when a command has one of these options you can almost always count on the same behavior of the option as in other commands. (Other command options, which are listed with the individual commands, may have different behavior from one CVS command to the other). *Warning:* the `history' command is an exception; it supports many options that conflict even with these standard options. `-D DATE_SPEC' Use the most recent revision no later than DATE_SPEC. DATE_SPEC is a single argument, a date description specifying a date in the past. The specification is "sticky" when you use it to make a private copy of a source file; that is, when you get a working file using `-D', CVS records the date you specified, so that further updates in the same directory will use the same date (for more information on sticky tags/dates, *note Sticky tags::.). A wide variety of date formats are supported by the underlying RCS facilities, similar to those described in co(1), but not exactly the same. The DATE_SPEC is interpreted as being in the local timezone, unless a specific timezone is specified. Examples of valid date specifications include: 1 month ago 2 hours ago 400000 seconds ago last year last Monday yesterday a fortnight ago 3/31/92 10:00:07 PST January 23, 1987 10:05pm 22:00 GMT `-D' is available with the `checkout', `diff', `export', `history', `rdiff', `rtag', and `update' commands. (The `history' command uses this option in a slightly different way; *note history options::.). Remember to quote the argument to the `-D' flag so that your shell doesn't interpret spaces as argument separators. A command using the `-D' flag can look like this: $ cvs diff -D "1 hour ago" cvs.texinfo `-f' When you specify a particular date or tag to CVS commands, they normally ignore files that do not contain the tag (or did not exist prior to the date) that you specified. Use the `-f' option if you want files retrieved even when there is no match for the tag or date. (The most recent revision of the file will be used). `-f' is available with these commands: `checkout', `export', `rdiff', `rtag', and `update'. *Warning:* The `commit' command also has a `-f' option, but it has a different behavior for that command. *Note commit options::. `-H' Help; describe the options available for this command. This is the only option supported for all CVS commands. `-k KFLAG' Alter the default RCS processing of keywords. *Note Keyword substitution::, for the meaning of KFLAG. Your KFLAG specification is "sticky" when you use it to create a private copy of a source file; that is, when you use this option with the `checkout' or `update' commands, CVS associates your selected KFLAG with the file, and continues to use it with future update commands on the same file until you specify otherwise. The `-k' option is available with the `add', `checkout', `diff' and `update' commands. `-l' Local; run only in current working directory, rather than recursing through subdirectories. *Warning:* this is not the same as the overall `cvs -l' option, which you can specify to the left of a cvs command! Available with the following commands: `checkout', `commit', `diff', `export', `log', `remove', `rdiff', `rtag', `status', `tag', and `update'. `-m MESSAGE' Use MESSAGE as log information, instead of invoking an editor. Available with the following commands: `add', `commit' and `import'. `-n' Do not run any checkout/commit/tag program. (A program can be specified to run on each of these activities, in the modules database (*note modules::.); this option bypasses it). *Warning:* this is not the same as the overall `cvs -n' option, which you can specify to the left of a cvs command! Available with the `checkout', `commit', `export', and `rtag' commands. `-P' Prune (remove) directories that are empty after being updated, on `checkout', or `update'. Normally, an empty directory (one that is void of revision-controlled files) is left alone. Specifying `-P' will cause these directories to be silently removed from your checked-out sources. This does not remove the directory from the repository, only from your checked out copy. Note that this option is implied by the `-r' or `-D' options of `checkout' and `export'. `-p' Pipe the files retrieved from the repository to standard output, rather than writing them in the current directory. Available with the `checkout' and `update' commands. `-W' Specify file names that should be filtered. You can use this option repeatedly. The spec can be a file name pattern of the same type that you can specify in the `.cvswrappers' file. Avaliable with the following commands: `import', and `update'. `-r TAG' Use the revision specified by the TAG argument instead of the default "head" revision. As well as arbitrary tags defined with the `tag' or `rtag' command, two special tags are always available: `HEAD' refers to the most recent version available in the repository, and `BASE' refers to the revision you last checked out into the current working directory. The tag specification is sticky when you use this option with `checkout' or `update' to make your own copy of a file: CVS remembers the tag and continues to use it on future update commands, until you specify otherwise (for more information on sticky tags/dates, *note Sticky tags::.). The tag can be either a symbolic or numeric tag. *Note Tags::. Specifying the `-q' global option along with the `-r' command option is often useful, to suppress the warning messages when the RCS history file does not contain the specified tag. *Warning:* this is not the same as the overall `cvs -r' option, which you can specify to the left of a cvs command! `-r' is available with the `checkout', `commit', `diff', `history', `export', `rdiff', `rtag', and `update' commands. File: cvs.info, Node: add, Next: admin, Prev: Common options, Up: Invoking CVS add--Add a new file/directory to the repository =============================================== * Synopsis: add [-k kflag] [-m 'message'] files... * Requires: repository, working directory. * Changes: working directory. * Synonym: new Use the `add' command to create a new file or directory in the source repository. The files or directories specified with `add' must already exist in the current directory (which must have been created with the `checkout' command). To add a whole new directory hierarchy to the source repository (for example, files received from a third-party vendor), use the `import' command instead. *Note import::. If the argument to `add' refers to an immediate sub-directory, the directory is created at the correct place in the source repository, and the necessary CVS administration files are created in your working directory. If the directory already exists in the source repository, `add' still creates the administration files in your version of the directory. This allows you to use `add' to add a particular directory to your private sources even if someone else created that directory after your checkout of the sources. You can do the following: $ mkdir new_directory $ cvs add new_directory $ cvs update new_directory An alternate approach using `update' might be: $ cvs update -d new_directory (To add any available new directories to your working directory, it's probably simpler to use `checkout' (*note checkout::.) or `update -d' (*note update::.)). The added files are not placed in the source repository until you use `commit' to make the change permanent. Doing an `add' on a file that was removed with the `remove' command will resurrect the file, unless a `commit' command intervened. *Note Removing files::, for an example. Unlike most other commands `add' never recurses down directories. It cannot yet handle relative paths. Instead of $ cvs add foo/bar.c you have to do $ cd foo $ cvs add bar.c * Menu: * add options:: add options * add examples:: add examples File: cvs.info, Node: add options, Next: add examples, Up: add add options ----------- There are only two options you can give to `add': `-k KFLAG' This option specifies the default way that this file will be checked out. The KFLAG argument (*note Substitution modes::.) is stored in the RCS file and can be changed with `admin -k' (*note admin options::.). See *Note Binary files::, for information on using this option for binary files. `-m DESCRIPTION' Using this option, you can give a description for the file. This description appears in the history log (if it is enabled, *note history file::.). It will also be saved in the RCS history file inside the repository when the file is committed. The `log' command displays this description. The description can be changed using `admin -t'. *Note admin::. If you omit the `-m DESCRIPTION' flag, an empty string will be used. You will not be prompted for a description. File: cvs.info, Node: add examples, Prev: add options, Up: add add examples ------------ To add the file `backend.c' to the repository, with a description, the following can be used. $ cvs add -m "Optimizer and code generation passes." backend.c $ cvs commit -m "Early version. Not yet compilable." backend.c File: cvs.info, Node: admin, Next: checkout, Prev: add, Up: Invoking CVS admin--Administration front end for rcs ======================================= * Requires: repository, working directory. * Changes: repository. * Synonym: rcs This is the CVS interface to assorted administrative RCS facilities, documented in rcs(1). `admin' simply passes all its options and arguments to the `rcs' command; it does no filtering or other processing. This command *does* work recursively, however, so extreme care should be used. If there is a group whose name matches a compiled in value which defaults to `cvsadmin', only members of that group can use `cvs admin'. To disallow `cvs admin' for all users, create a group with no users in it. * Menu: * admin options:: admin options * admin examples:: admin examples File: cvs.info, Node: admin options, Next: admin examples, Up: admin admin options ------------- Not all valid `rcs' options are useful together with CVS. Some even makes it impossible to use CVS until you undo the effect! This description of the available options is based on the `rcs(1)' man page, but modified to suit readers that are more interrested in CVS than RCS. `-AOLDFILE' Might not work together with CVS. Append the access list of OLDFILE to the access list of the RCS file. `-aLOGINS' Might not work together with CVS. Append the login names appearing in the comma-separated list LOGINS to the access list of the RCS file. `-b[REV]' When used with bare RCS, this option sets the default branch to REV; in CVS sticky tags (*note Sticky tags::.) are a better way to decide which branch you want to work on. With CVS, this option can be used to control behavior with respect to the vendor branch. `-cSTRING' Useful with CVS. Sets the comment leader to STRING. The comment leader is printed before every log message line generated by the keyword `$Log$' (*note Keyword substitution::.). This is useful for programming languages without multi-line comments. RCS initially guesses the value of the comment leader from the file name extension when the file is first committed. `-e[LOGINS]' Might not work together with CVS. Erase the login names appearing in the comma-separated list LOGINS from the access list of the RCS file. If LOGINS is omitted, erase the entire access list. `-I' Run interactively, even if the standard input is not a terminal. `-i' Useless with CVS. When using bare RCS, this is used to create and initialize a new RCS file, without depositing a revision. `-kSUBST' Useful with CVS. Set the default keyword substitution to SUBST. *Note Keyword substitution::. Giving an explicit `-k' option to `cvs update', `cvs export', or `cvs checkout' overrides this default. `-l[REV]' Lock the revision with number REV. If a branch is given, lock the latest revision on that branch. If REV is omitted, lock the latest revision on the default branch. This can be used in conjunction with the `rcslock.pl' script in the `contrib' directory of the CVS source distribution to provide reserved checkouts (where only one user can be editing a given file at a time). See the comments in that file for details (and see the `README' file in that directory for disclaimers about the unsupported nature of contrib). According to comments in that file, locking must set to strict (which is the default). `-L' Set locking to strict. Strict locking means that the owner of an RCS file is not exempt from locking for checkin. For use with CVS, strict locking must be set; see the discussion under the `-l' option above. `-mREV:MSG' Replace the log message of revision REV with MSG. `-NNAME[:[REV]]' Act like `-n', except override any previous assignment of NAME. `-nNAME[:[REV]]' Associate the symbolic name NAME with the branch or revision REV. It is normally better to use `cvs tag' or `cvs rtag' instead. Delete the symbolic name if both `:' and REV are omitted; otherwise, print an error message if NAME is already associated with another number. If REV is symbolic, it is expanded before association. A REV consisting of a branch number followed by a `.' stands for the current latest revision in the branch. A `:' with an empty REV stands for the current latest revision on the default branch, normally the trunk. For example, `rcs -nNAME: RCS/*' associates NAME with the current latest revision of all the named RCS files; this contrasts with `rcs -nNAME:$ RCS/*' which associates NAME with the revision numbers extracted from keyword strings in the corresponding working files. `-oRANGE' Potentially useful, but dangerous, with CVS (see below). Deletes ("outdates") the revisions given by RANGE. A range consisting of a single revision number means that revision. A range consisting of a branch number means the latest revision on that branch. A range of the form `REV1:REV2' means revisions REV1 to REV2 on the same branch, `:REV' means from the beginning of the branch containing REV up to and including REV, and `REV:' means from revision REV to the end of the branch containing REV. None of the outdated revisions may have branches or locks. Due to the way CVS handles branches REV cannot be specified symbolically if it is a branch. *Note Magic branch numbers::, for an explanation. Make sure that no-one has checked out a copy of the revision you outdate. Strange things will happen if he starts to edit it and tries to check it back in. For this reason, this option is not a good way to take back a bogus commit; commit a new revision undoing the bogus change instead (*note Merging two revisions::.). `-q' Run quietly; do not print diagnostics. `-sSTATE[:REV]' Useful with CVS. Set the state attribute of the revision REV to STATE. If REV is a branch number, assume the latest revision on that branch. If REV is omitted, assume the latest revision on the default branch. Any identifier is acceptable for STATE. A useful set of states is `Exp' (for experimental), `Stab' (for stable), and `Rel' (for released). By default, the state of a new revision is set to `Exp' when it is created. The state is visible in the output from CVS LOG (*note log::.), and in the `$Log$' and `$State$' keywords (*note Keyword substitution::.). Note that CVS uses the `dead' state for its own purposes; to take a file to or from the `dead' state use commands like `cvs remove' and `cvs add', not `cvs admin -s'. `-t[FILE]' Useful with CVS. Write descriptive text from the contents of the named FILE into the RCS file, deleting the existing text. The FILE pathname may not begin with `-'. If FILE is omitted, obtain the text from standard input, terminated by end-of-file or by a line containing `.' by itself. Prompt for the text if interaction is possible; see `-I'. The descriptive text can be seen in the output from `cvs log' (*note log::.). `-t-STRING' Similar to `-tFILE'. Write descriptive text from the STRING into the RCS file, deleting the existing text. `-U' Set locking to non-strict. Non-strict locking means that the owner of a file need not lock a revision for checkin. For use with CVS, strict locking must be set; see the discussion under the `-l' option above. `-u[REV]' See the option `-l' above, for a discussion of using this option with CVS. Unlock the revision with number REV. If a branch is given, unlock the latest revision on that branch. If REV is omitted, remove the latest lock held by the caller. Normally, only the locker of a revision may unlock it. Somebody else unlocking a revision breaks the lock. This causes a mail message to be sent to the original locker. The message contains a commentary solicited from the breaker. The commentary is terminated by end-of-file or by a line containing `.' by itself. `-VN' Emulate RCS version N. Use -VN to make an RCS file acceptable to RCS version N by discarding information that would confuse version N. `-xSUFFIXES' Useless with CVS. Use SUFFIXES to characterize RCS files.