Introduction to CVS

<h1>Cmiss CVS Overview</h1>

<h2>Setup</h2>

See Setting Up for CMISS CVS Access for CMISS-specific settings.

Use cvs h for a list of cvs subcommands, cvs -H subcommand for help on a subcommand, or cvs --help-options for help on global cvs options, or check the <a href="http://ximbiot.com/cvs/manual/">documentation</a>.

<h2>cvs checkout</h2> This command gets you started with cvs. Before you can do much with cvs you need to `checkout' a working directory. The working directory is made in the current directory and is given the same name as the repository unless specified with the -d option. Go where you want the base of your working directory to be and checkout the things you want to edit. Examples <ul><li>cvs checkout examples/e/e1 makes the working directory

`examples/e/e1' and checks out all subdirectories and files in this part of the repository tree. </li><li>cvs checkout cm/source/fe26.f makes the working directory `cm/source' and checks out file `fe26.f' from repository `cm/source' into the working directory. </li><li>cvs checkout -d . cm/source/fe26.f This makes the current directory a working directory for repository `cm/source' and checks out file `fe26.f' into the current directory.</li></ul>

If you have created a working directory by checking out a subset of files (i.e. you have specified files not a directory), then you can check out and release more files with cvs update described below. The <a href="http://ximbiot.com/cvs/manual/"> documentation on cvs checkout</a> describes further options.

<h2>cvs update</h2> This command gets your checked out code up to date. It will automatically merge anyone elses changes to the repository into your code. It is guaranteed to preserve anything you have done. You start cvs update at any point in a checked out tree and it will recursively descend through any cvs controlled sub directories too.

Many suffixes are ignored (all *.o *~ files etc. are ignored). Every other file is compared to the repository. If nothing has changed locally or in the repository it is passed over silently. In each other case a symbol is used to explain the status/changes. <ul><li>A means that you have scheduled the file for addition.</li><li>R means that you have scheduled the file for removal.</li><li>M means that you have made some modifications that aren't checked in.</li><li>? means that the file is unknown by CVS.</li><li>U means that your file has been updated with changes from the repository.</li><li>C means that your changes conflict with those that someone else has made. Your original file is preserved as .#{filename}.{version}. CVS does the best job it can and leaves the rest up to you, bracketed by >>>>> ===== <<<<<. Sometimes this is easy to resolve, sometimes you need to compare your .# file with the previous repository version and add your changes to the latest repository version as in an old style merge. </li></ul>

Example <pre>esu48:blackett 1582% cvs update cvs update: Updating . M cmgui.c M cmgui.imake ? date.h ? yesterday ? cmgui_sgi.make ? object ? cmgui.imake.perl ? cmgui_sgiperl.depend ? cmgui_sgi_memorycheck.make ? cmgui_sgiperl.make ? cmgui_sgi_memorycheck.depend.tmp ? object.list ? cmgui_sgioptimised.make ? cmgui_sgif90.make ? cmgui_linux.make ? unemap_sgi.make ? cmgui_linux_optimised.make ? unemap_linux.make cvs update: Updating comfile M comfile/comfile_window.c cvs update: Updating command M command/cmiss.c M command/cmiss.h M command/parser.c ? command/cmiss_modify_new.c A command/f90_interpreter.h A command/f90_interpreter.c ? command/Perl_cmiss.pmh ? command/Perl_cmiss ? command/perl_interpreter.h cvs update: Updating finite_element cvs update: Updating general M general/child_process.c M general/image_utilities.c ? general/image_utilities.c.new cvs update: Updating graphics M graphics/import_graphics_object.c M graphics/import_graphics_object.h M graphics/texture.c ? graphics/scene_viewer.c.conflict cvs update: Updating link cvs update: Updating mirage ? mirage/tracking_socket_linux_test_log ? mirage/tracking_socket_linux_test ? mirage/tracking_socket_test.c ? mirage/tracking_socket_test_log ? mirage/tracking_socket_test cvs update: Updating slider cvs update: Updating user_interface M user_interface/filedir.c M user_interface/message.c </pre> The -n option for cvs prevents cvs from modifying any files. cvs -n update shows what a cvs update would do, and is therefore useful for giving the status of the working directory.

If an entire working directory has been checked out (i.e. a directory has been specified for cvs checkout), cvs update will check out any new files that have been added to the repository.

If only a subset of files have been checked out into the working directory, additional files may be checked out using cvs update file. If you no longer want a file in your working directory it can be released using cvs update -r 0 file. This command updates the revision of file in your working directory to revision 0. Revision 0 does not exist so it removes file from your working directory. If you have made changes to file, it will not be deleted and a conflict will be reported.

The <a href="http://ximbiot.com/cvs/manual/"> documentation on cvs update</a> describes further options.

<h2>cvs log</h2> This command tells you about changes that have been made to the repository. The -d option allows you to list changes between a range of dates. (D1 < D2 for all changes between a range of dates, D for latest since a certain date). CVS understands lots of date formats including yesterday, "last week", Examples <ul><li>cvs log ${CMISS_EXAMPLES}/e/ea/ea1/cmiss_input/example_ea1.com Lists all changes

to this file as recorded by cvs . </li><li>cvs log -d ">yesterday" ${CMISS_EXAMPLES}/e/ea/ea1/cmiss_input/example_ea1.com Lists all changes to this file since yesterday. </li><li>cvs log -d "yesterday" ${CMISS_EXAMPLES}/e/ea/ea1/cmiss_input/example_ea1.com Lists just the lastest change made to this file before yesterday. </li><li>cvs log -d "10 jun 2000>15 apr 2000" ${CMISS_EXAMPLES}/e/ea/ea1/cmiss_input/example_ea1.com Lists changes to this file between the 15 April and the 10th of June. </li></ul>

The <a href="http://ximbiot.com/cvs/manual/"> documentation on cvs log</a> describes further options.

<h2>Making changes</h2>

When committing changes to files, provide a log message that describes the change and why it was made.

<ul><li>To add a directory

 1. Simply add it to cvs 'cvs add dirname'</li>

<li>To add a file

 1. Tell cvs you are going to add the file with 'cvs add -m "description of file" filename' 2. Run 'cvs update' 3. Commit your changes with 'cvs commit -m "Initial revision of a cvs example" filename' </li><li>4. After committing new files, you need to compile the global cmiss immediately.

</li><li>To remove a file: 1. Remove the file using 'rm filename' 2. Tell cvs that you are going to remove the file with 'cvs remove filename' 3. Run 'cvs update' 4. Commit your changes with 'cvs commit -m "Removed as this is superseded by filename2" filename'</li><li>Checking in changes 1. Run 'cvs update' 2. Commit your changes with 'cvs commit -m "Added streamlines to provide the ability to follow the path of a particle" filename' or 'cvs commit -m "Added a Hunter correction as the solution would diverge when A was much greater than B." filename'</li></ul>

If you don't supply a message with your commit, cvs will start an editor for you to write and save a log message before exiting. cvs looks for an editor in the environment variables CVSEDITOR then EDITOR. If you don't like using vi, then make sure you set one of these variables to your favourite editor.

Personal tools

Introduction to CVS