14.4.4.2. .cvswrappers files

14.4.4.3. CVS directories

Table 14-15. Files in the CVS Directories

Since each sandbox directory has one CVS/Root file, a sandbox directory corresponds to exactly one repository. You cannot check out some files from one repository and some from another into a single sandbox directory.

14.4.6.1. Date formats

ISO standard

The preferred format is YYYY-MM-DD HH:MM, which would read as 2000-05-17, or 2000-05-17 22:00. The technical details of the format are defined in the ISO 8601 standard.

Email standard

17 May 2000. The technical details of the format are defined in the RFC 822 and RFC 1123 standards.

Relative

10 days ago, 4 years ago.

Common

month/day/year. This form can cause confusion because not all cultures use the first two fields in this order (1/2/2000 would be ambiguous).

Other

Other formats are accepted, including YYYY/MM/DD and those omitting the year (which is assumed to be the current year).

14.4.6.2. Keyword substitutions

Table 14-19. Keyword Substitution Modes

Keyword substitution fields are strings of the form $Keyword ...$. The valid keywords are:

Author

The user ID of the person who committed the revision.

Date

The date and time (in standard UTC format) the revision was committed.

Header

The full path of the repository RCS file, the revision number, the commit date, time, and user ID, the file's state, and the lock holder's user ID if the file is locked.

Id

A shorter form of Header, omitting the leading directory name(s) from the RCS file's path, leaving only the filename.

Name

The tag name used to retrieve the file, or empty if the no explicit tag was given when the file was retrieved.

Locker

The user ID of the user holding a lock on the file, or empty if the file is not locked.

Log

The RCS filename. In addition to keyword expansion in the keyword field, each commit adds additional lines in the file immediately following the line containing this keyword. The first such line contains the revision number, the commit date, time, and user ID. Subsequent lines are the contents of the commit log message. The result over time is a reverse-chronological list of log entries for the file. Each of the additional lines is preceded by the same characters that precede the keyword field on its line. This allows the log information to be formatted in a comment for most languages. For example:

#
# ch14_04.htm
#
# $Log: ch14_04.htm,v $
# Revision 1.3  2001/06/22 16:14:09  ellie
# replaced grave entity w/literal backtic
#
# Revision 1.2  2001/06/18 18:28:37  ellie
# regenerated after xslt fixes
#
# Revision 1.1  2000/06/09 18:07:51  ellie
# Fixed the last remaining bug in the system.
#

Be sure that you don't place any keyword fields in your log messages if you use this keyword, since they will get expanded if you do.

RCSfile

The name of the RCS file (without any leading directories).

Revision

The revision number of the file.

Source

The full path of the RCS file.

State

The file's state, as assigned by cvs admin -s (if you don't set the state explicitly, it will be Exp by default).

14.4.7.1. add

add
  [ -k kflag ]
  [ -m message ]
  file ...

The standard meaning of the common client option -k applies. There is only one additional option that can be used with the add command: -m message. This option is used to provide a description of the file (which appears in the output of the log command).

14.4.7.2. annotate

annotate
  [ [ -D date | -r rev ] -f ]
  [ -l | -R ]
  file ...

The standard meanings of the common client options -D, -f, -l, -r, and -R apply.

14.4.7.3. checkout

checkout
  [ -A ]
  [ -c | -s ]
  [ -d dir [ -N ] ]
  [ [ -D date | -r rev ] -f ]
  [ -j rev1 [ -j rev2 ] ]
  [ -k kflag ]
  [ -l | -R ]
  [ -n ]
  [ -p ]
  [ -P ]
  module ...

Table 14-21. Checkout Options

14.4.7.4. commit

commit
  [ -f | [ -l | -R ] ]
  [ -F file | -m message ]
  [ -n ]
  [ -r revision ]
  [ files ... ]

Table 14-22. commit Options

Use of the -r option causes the revision to be sticky, requiring the use of admin -A to continue to use the sandbox.

14.4.7.5. diff

diff
  [ -k kflag ]
  [ -l | -R ]
  [ format ]
  [ [ -r rev1 | -D date1 ] [ -r rev2 | -D date2 ] ]
  [ file ... ]

14.4.7.6. edit

edit
  [ -a action ]
  [ -l | -R ]
  [ file ... ]

The standard meanings of the common client options -l and -R apply. There is only one additional option that can be used with the edit command: -a actions. This option is used to specify the actions to watch. The legal values for actions are described in the entry for the watch command.

14.4.7.7. editors

editors
  [ -l | -R ]
  [ file ... ]

The standard meanings of the common client options -l and -R apply.

See also the later section on watch.

14.4.7.8. export

export
  [ -d dir [ -N ] ]
  [ -D date | -r rev ]
  [ -f ]
  [ -k kflag ]
  [ -l | -R ]
  [ -n ]
  [ -P ]
  module ...

user@localhost$ cvs export -r foo-1_0 -d foo-1.0 foo
user@localhost$ tar czf foo-1.0.tar.gz foo-1.0

Table 14-23. export Options

When checking out a single file located one or more directories down in a module's directory structure, the -N option can be used with -d to prevent the creation of intermediate directories.

14.4.7.9. help

help

14.4.7.10. history

history
  [ -a | -u user ]
  [ -b string ]
  [ -c ]
  [ -D date ]
  [ -e | -x type ]
  [ -f file | -m module | -n module | -p repository ]... 
  [ -l ]
  [ -o ]
  [ -r rev ]
  [ -t tag ]
  [ -T ]
  [ -w ]
  [ -z zone ]
  [ file ... ]

Table 14-24. history Options

The -p option should limit the history report to entries for the directory or directories (if multiple -p options are specified) given, but as of Version 1.10.8, it doesn't seem to affect the output. For example, to report history for the CVSROOT and hello modules, run the command:

cvs history -p CVSROOT -p hello

Using -t is faster than using -r because it only needs to search through the history file, not all of the RCS files.

Table 14-25. Update-Related history Record Types

Table 14-26. Commit-Related history Record Types

Table 14-27. Other history Record Types

14.4.7.11. import

import
  [ -b branch ]
  [ -d ]
  [ -I pattern ]
  [ -k kflag ]
  [ -m message ]
  [ -W spec ]
  module
  vendor_tag
  release_tag ...

Table 14-28. import Options

The -k setting will apply only to those files imported during this execution of the command. The keyword substitution modes of files already in the repository are not modified.

Table 14-29. import Status Codes

14.4.7.12. log

log
  [ -b ]
  [ -d dates ]
  [ -h ]
  [ -N ]
  [ -rrevisions ]
  [ -R ]
  [ -s state ]
  [ -t ]
  [ -wlogins ]
  [ file ... ]

Table 14-30. log Options

Table 14-31. log Date Range Specifications

Table 14-32. log Revision Specifications

For rev1:rev2, it is an error if the revisions are not on the same branch.

14.4.7.13. login

login

14.4.7.14. logout

logout

14.4.7.15. rdiff

rdiff
  [ -c | -s | -u ]
  [ { { -D date1 | -r rev1 } [ -D date2 | -r rev2 ] } | -t ]
  [ -f ]
  [ -l | -R ]
  [-V vn]
  file ...

Table 14-33. rdiff Options

14.4.7.16. release

release
  [ -d ]
  directory ...

There is only one option that can be used with the release command, -d. The -d option will delete the sandbox copy if no uncommitted changes are present.

Table 14-34. release Status Codes.

14.4.7.17. remove

remove
  [ -f ]
  [ -l | -R ]
  [ file ... ]

The standard meanings of the common client options -l and -R apply. Only one other option may be used with the remove command, -f. When used, -f will delete the file from the sandbox first.

14.4.7.18. rtag

rtag
  [ -a ]
  [ -b ]
  [ -d ]
  [ -D date | -r rev ]
  [ -f ]
  [ -F ]
  [ -l | - R ]
  [ -n ]
  tag
  file ...

Table 14-35. rtag Options

14.4.7.19. status

status
  [ -l | -R ]
  [ -v ]
  [ file ... ]

The standard meanings of the common client options -l and -R apply. The other option that can be used with the status command, -v, may be used to include tag information.

14.4.7.20. tag

tag
  [ -b ]
  [ -c ]
  [ -d ]
  [ -D date | -r rev ]
  [ -f ]
  [ -F ]
  [ -l | R ]
  tag
  [ file ... ]

The tag must start with a letter and must consist entirely of letters, numbers, dashes (-) and underscores (_). Therefore, while you might want to tag your hello project with 1.0 when you release Version 1.0, you'll need to tag it with something like hello-1_0 instead.

Table 14-36. tag Options

Since the -d option throws away information that might be important, it is recommended that you use it only when absolutely necessary. It is usually better to create a different tag with a similar name.

14.4.7.21. unedit

unedit
  [ -l | -R ]
  [ file ... ]

The standard meanings of the common client options -l and -R apply.

14.4.7.22. update

update
  [ -A ]
  [ -d ]
  [ -D date | -r rev ]
  [ -f ]
  [ -I pattern ]
  [ -j rev1 [ -j rev2 ] ]
  [ -k kflag ]
  [ -l | -R ]
  [ -p ]
  [ -P ]
  [ -W spec ]
  [ file ... ]

can be used to do a quick status check of the current sandbox versus the head of the trunk of development.

Table 14-37. update Options

Using -D or -r results in sticky dates or tags, respectively, on the affected files (using -p along with these prevents stickiness). Use -A to reset any sticky tags or dates.

If two -j specifications are made, the differences between them are computed and applied to the current file. If only one is given, then the common ancestor of the sandbox revision and the specified revision is used as a basis for computing differences to be merged.

For example, suppose a project has an experimental branch, and important changes to the file foo.c were introduced between revisions 1.2.2.1 and 1.2.2.2. Once those changes have proven stable, you want them reflected in the main line of development. From a sandbox with the head revisions checked out, we run:

user@localhost$ cvs update -j 1.2.2.1 -j 1.2.2.2 foo.c

CVS finds the differences between the two revisions and applies those differences to the file in our sandbox.

Table 14-38. update Status Codes

14.4.7.23. watch

watch
  { { on | off } | { add | remove } [ -a action ] }
  [ -l | -R ]
  file ...

The CVSROOT/notify file determines how notifications are performed.

Table 14-39. watch Sub-commands

Table 14-40. watch Actions

See also the descriptions of the edit, editors, unedit, and watchers commands.

14.4.7.24. watchers

watchers
  [ -l | -R ]
  [ file ... ]

The standard meanings of the common client options -l and -R apply.