TweetFollow Us on Twitter

Oct 00 Online

Volume Number: 16 (2000)
Issue Number: 10
Column Tag: MacTech Online

CVS: Version Control is Your Friend

by Jeff Clites <online@mactech.com>

CVS, the Concurrent Versions System, is the standard in version control systems in the Unix world. Traditional Mac users may not have used CVS before, and in fact may not have used any version control system, but it can save you numerous headaches during your development projects, and with the arrival of Mac OS X there is no longer any excuse-CVS is free and may even come preinstalled with your developer tools.

So what is a version control system? In short, it allows you to manage and track changes to the files of a project. From an operational standpoint, most systems (including CVS) are based on a central repository which contains all of the files of your project, and individual developers "check out" copies of these files, make changes to their local copies, and then "check in" their changes to the central repository. In the process, the system does three basic things for you: it helps coordinate a team of developers working on the same project (so that programmers don't interfere with other programmers working on the same files); it tracks what changes were made to what file, when they were made, why they were made, and who made them (this helps you identify the cause of a newly introduced bug and helps enforce developer accountability); and it allows you to revert to a version of your project that existed at some previous point in time (this allows you to test compatibility with previous versions or to undo destabilizing changes). Version control isn't a magic bullet or a substitute for communication between developers, but it does go a long way toward preventing common (and annoying) problems. Version control is a must when multiple developers are involved in a project, but even a single developer working alone will benefit.

The main advantage that CVS has over most if its competitors is that it uses optimistic locking rather than pessimistic locking for checked-out file. With pessimistic locking, only one developer can check out and modify a given file at one time, in order to prevent two users from stepping on each others changes in the same file. This sounds like a good idea on the surface, but in practice it can become a major impediment if users keep files checked out for long periods of time, as they would naturally do when editing them, or as they may accidentally do if they forget to check them backing in before leaving for lunch, for the day, or for vacation. Ultimately, users will resort to circumventing the system to obtain a copy of a "locked" file so that they can get some work done, and they'll have to manually reconcile their changes with the user who originally checked out the file. CVS takes a completely different approach-it doesn't lock access to files at all. Multiple users are free to check out and work on the same files at the same time, and the system takes care of merging changes together as users commit their modifications back into the central repository. The majority of the time, users don't actually end up editing the same files at the same time (even though they may have checked them out, for instance to look them over for needed changes), and even when they do CVS is able to merge these changes together automatically. In the rare case in which two users have both modified the same line of code between check-ins, CVS notifies the user of a conflict so that he can resolve it manually. This sound like it could cause a mess, but in practice it usually does just what you would have wanted, and it only makes you spend your time resolving the rare conflict when it actually does occur, rather than causing ongoing interruptions in order to ward off potential problems that never actually arise.

CVS has many strong points in addition to the above-mentioned "non-locking" behavior. For instance, it is open source and licensed under the GPL, and therefore is available free of charge. Also, despite its Unix heritage, there are GUI-based clients available for the classic Mac OS and for Windows. On the other hand, CVS is far from perfect-it has been said that it's terrible but it's the best thing around. Many if its flaws are merely nits, but they can add up to a noticeable inconvenience. To begin with, CVS shares a problem which is unfortunately common among open-source projects, namely that it has a significant amount of documentation yet it is often difficult to find the exact information you are looking for. For example, a very nice feature of CVS is that it can be configure to run over SSH, so that passwords and data are encrypted during transmission. It's hard to find a complete discussion of this feature, and the setup is such that it's easy to think that you've enabled this feature when in fact you haven't. (There also doesn't appear to be a way to force the use of SSH from the server side, i.e. to ensure that clients cannot connect insecurely.)

A second annoyance is the somewhat inconvenient handling of directories. CVS fundamentally works on a per-directory basis, and in each directory it places a "CVS" subdirectory with configuration information. This can cause problems if you duplicate a directory and forget to remove the duplicate CVS information. Under Mac OS X there are many types of "files" which are actually directories, and tools which manipulate these need to be CVS-aware so that they don't remove the CVS information when saving. Some of these "magic directories" (for instance InterfaceBuilder's .nib files) are best thought of as opaque binary files, whose contents should not be manipulated by merge tools, and there is a "wrappers" facility which allows you to treat them as such but, inexplicably, this feature is not compatible with client-server operation. Fortunately, Codefab maintains a modified version of CVS which does support both of these features, although it's a shame that the CVS maintainers don't seem to be interested in merging this back into the core distribution. This still doesn't solve the problem for "magic directories" which you don't want to treat as binary (such as EOModeler's .eomodeld files), but fortunately the latest incarnations of Apple's developer tools seem to handle the CVS directories correctly. For older version, the Omni Group has plug-ins which fix this problem, for both EOModeler and InterfaceBuilder. The directory-centric nature of CVS also has the unpleasant side-effect that you can't really remove a directory from you project - you can only remove the files which it contains. There is a workaround in that there is a setting which tells CVS not to create empty directories during a checkout, but this has the side effect that you can't place an empty directory under version control. (It's rare that you would need to, but it's important to keep in mind in case you ever do.) On a related note, you can place binary files (such as images) under version control, but you have to go through a bit of special configuration to flag them as binary so that CVS doesn't corrupt them, for instance by doing line-ending conversion. Often, these types of files do not really need to be under version-control per se, but it's very convenient to place them in your repository nonetheless so that you can maintain a complete copy of your project, especially in web development projects which tend to contain a large number of image files.

Documentation

Apple itself uses CVS for some of its internal development projects, and in fact Mac OS X Server shipped with it pre-installed. In particular it is used with the Darwin project, and there is a page on their Public Source site which serves as a good jumping-off point to find documentation and other information about CVS. Here you'll find a brief introduction to CVS concepts, by Apple's Wilfredo Sánchez. A good next stop is Jim Blandy's "Introduction to CVS", which goes into a bit more detail. Next up is "Open Source Development with CVS", a book by Karl Fogel. Generously, although this is a commercial book, the chapters on CVS itself are available for free in a variety of electronic formats. It is extensive, well-written, and a pleasant read. Finally, there is the core CVS manual, "Version Management with CVS", colloquially referred to as "the Cederqvist", for the name of its original author. It is large and complete, but it may not be the best place to start out. Finally, for an account of using CVS specifically with web development projects, take a look at "CVS Version Control for Web Site Projects".

Much of the core documentation is located on the main CVS site, CVShome.org, and it's a good place to look for additional information and to download CVS itself, despite the somewhat inconvenient organization of the site. Their documentation page has links to the most important references, including overviews of CVS and of version control, and a CVS commands quick reference. (O'Reilly has also just published their CVS Pocket Reference, if you'd like something a little more extensive and in printed form.) Also check out the CVS Bubbles site, and especially its documentation page, which has links to a number of tutorials and to other CVS sites.

Alternatives

If you're a classic Mac OS user, you'll have to run the CVS server on a Unix machine, but there are several different clients that you can run: MacCVS Pro, MacCvs, and MacCVSClient. Despite their similar names, these are separate applications. The first of these, MacCVS Pro, is sponsored by the Mozilla project, and appears to be the most current version.

Under Mac OS X, CVS should work "out of the box" thanks to the BSD layer. If you don't like the command-line version (which really is quite easy to use), there is a GUI front end, CVL (Concurrent Versions Librarian) by Sen:te. CVL works on top of the standard CVS rather than replacing it. This is nice, because it should be forward-compatible, and it also means that you can resort to the command-line version if there is some additional feature you need to use which CVL doesn't support, and you can do this without worrying that you might "mess up" any of the locally-stored administrative information.

Finally, if CVS isn't to your liking after you've tried it out, there are several alternatives, and you might want to use one of the commercial systems. For the classic Mac OS there is VOODOO (Versions of Outdated Documents Organized Orthogonally). If you need support for multiple platforms, take a look at Perforce, which seems to be well liked and is available for a wide range of operating systems, although there don't appear to be any GUI-based clients for it. (While visiting Perforce's site you might also want to check out JAM, which is a build system designed as an alternative to make, and which is used as the build system under Mac OS X's ProjectBuilder.)

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Postbox 5.0.9 - Powerful and flexible em...
Postbox is a new email application that helps you organize your work life and get stuff done. It has all the elegance and simplicity of Apple Mail, but with more power and flexibility to manage even... Read more
VueScan 9.5.61 - Scanner software with a...
VueScan is a scanning program that works with most high-quality flatbed and film scanners to produce scans that have excellent color fidelity and color balance. VueScan is easy to use, and has... Read more
DiskCatalogMaker 6.5.16 - Catalog your d...
DiskCatalogMaker is a simple disk management tool which catalogs disks. Simple, light-weight, and fast. Finder-like intuitive look and feel. Super-fast search algorithm. Can compress catalog data... Read more
TrailRunner 3.8.827 - Route planning for...
TrailRunner is the perfect companion for runners, bikers, hikers, and all people wandering under the sky. Plan routes on a geographical map. Import GPS or workout recordings and journalize your... Read more
Civilization VI 1.0.1 - Next iteration o...
Sid Meier’s Civilization VI is the next entry in the popular Civilization franchise. Originally created by legendary game designer Sid Meier, Civilization is a strategy game in which you attempt to... Read more
Chromium 55.0.2883.75 - Fast and stable...
Chromium is an open-source browser project that aims to build a safer, faster, and more stable way for all Internet users to experience the web. Version 55.0.2883.75: Security fixes: High CVE-2016... Read more
Google Chrome 55.0.2883.75 - Modern and...
Google Chrome is a Web browser by Google, created to be a modern platform for Web pages and applications. It utilizes very fast loading of Web pages and has a V8 engine, which is a custom built... Read more
VirtualBox 5.1.10 - x86 virtualization s...
VirtualBox is a family of powerful x86 virtualization products for enterprise as well as home use. Not only is VirtualBox an extremely feature rich, high performance product for enterprise customers... Read more
Pixa 1.1.9 - Quickly and easily organize...
Pixa is an image-organizing application. The new app functions well, is easy to use, and helps people organize their images quickly and easily on their computers. For those who prefer not to use the... Read more
VirtualBox 5.1.10 - x86 virtualization s...
VirtualBox is a family of powerful x86 virtualization products for enterprise as well as home use. Not only is VirtualBox an extremely feature rich, high performance product for enterprise customers... Read more

Latest Forum Discussions

See All

Amateur Surgeon 4 Guide: Become the worl...
It's time to wield your trusty pizza cutter again, as Amateur Surgeon has returned with a whole fresh set of challenges (and some old, familiar ones, too). Starting anew isn't easy, especially when all you have at your disposal is a lighter, the... | Read more »
Le Parker: Sous Chef Extraordinaire (Ga...
Le Parker: Sous Chef Extraordinaire 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: | Read more »
Telltale Games really is working on a Gu...
Telltale Games' next episodic adventure is indeed Guardians of the Galaxy. A document tied to the voice actors strike suggested that the project was in the work, but now we have direct confirmation following an announcement at the Game Awards that... | Read more »
Amateur Surgeon returns to iOS and Andro...
Amateur Surgeon and its two sequels disappeared from the App Store some time and it was sad days for all. But now, just in time for the holidays, the Adult Swim favorite makes its joyous return in the shape of Amateur Surgeon 4, a remake with... | Read more »
The best board games on mobile
Sometimes you need to ditch all of the high speed, high action games in favor of something a little more traditional. If you don't feel like parting ways from your mobile device, though, there are still plenty of ways to get that old-school fix.... | Read more »
The best Facebook Messenger Instant Game...
Facebook's new Instant Games is now here, meaning you can play games with your friends directly via Facebook. It's a fun new way to connect with friends, of course, but it's also proving to be a solid gaming experience in its own right, with a... | Read more »
You can now play game's on Facebook...
Facebook launched its new Instant Games platform in an exciting new attempt to engage its user base. As a result, you can now play a number of different games directly through Facebook Messenger. All of these games run with HTML5, meaning you play... | Read more »
Apollo Justice Ace Attorney (Games)
Apollo Justice Ace Attorney 1.00.00 Device: iOS Universal Category: Games Price: $.99, Version: 1.00.00 (iTunes) Description: Court Is Back In Session Star as rookie defense attorney, Apollo Justice, as he visits crime scenes,... | Read more »
KORG iWAVESTATION (Music)
KORG iWAVESTATION 1.0 Device: iOS Universal Category: Music Price: $19.99, Version: 1.0 (iTunes) Description: A revolutionary new world of sound.The Wave Sequence Synthesizer for iPad - KORG iWAVESTATION | Read more »
Don't Grind Guide: Tips for becomin...
Don’t Grind is a surprising, derpy little one touch game with fun hand-drawn graphics. The goal is simple -- get the high score without being chopped to bits. That can be tough when you’re not used to the game, and that’s compounded by the fact... | Read more »

Price Scanner via MacPrices.net

Holiday sale: Apple MacBook Airs available fo...
B&H Photo has 13″ MacBook Airs on sale for $100 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 1.6GHz/128GB MacBook Air (MMGF2LL/A): $899 $100 off MSRP - 13″ 1.6GHz/... Read more
13-inch Silver Touch Bar MacBook Pro in stock...
Amazon has the new 2016 13″ 2.9GHz/256GB Silver Touch Bar MacBook Pro (MLVP2LL/A) in stock today and on sale for $1749 including free shipping. That’s $50 off MSRP, and it’s the lowest price... Read more
Parallels Toolbox 1.3 for Mac Offers 25 Singl...
Parallels has launched Parallels Toolbox 1.3 for Mac, an upgrade that adds five new utilities to the stand-alone application which was released in August and is available exclusively online at http... Read more
OWC Mercury Elite Pro Dual mini Ultra-Portabl...
OWC has introduced the new OWC Mercury Elite Pro Dual mini, a powerful yet ultra-portable dual-drive RAID solution. The new Mercury Elite Pro Dual mini packs phenomenal performance into a small... Read more
Clearance 13-inch Retina MacBook Pros availab...
B&H Photo has clearance 2015 13″ Retina Apple MacBook Pros available for up to $200 off original MSRP. Shipping is free, and B&H charges NY tax only: - 13″ 2.7GHz/128GB Retina MacBook Pro: $... Read more
Roundup of 2016 13-inch 2.0GHz MacBook Pro sa...
B&H has the non-Touch Bar 13″ MacBook Pros in stock today for $50-$100 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 2.0GHz MacBook Pro Space Gray (MLL42LL/A): $1449 $... Read more
New 13-inch 2.0GHz Space Gray MacBook Pro in...
Adorama has the new 13″ 2.0GHz Space Gray MacBook Pro (non-Touch Bar, MLL42LL/A) in stock for $1499 including a free 3-year AppleCare Protection Plan. Shipping is free, and Adorama charges sales tax... Read more
Finnair Adopts iOS Enterprise iPad Apps from...
Finnair and IBM have announced a first-of-its-kind agreement to utilize iOS enterprise apps from IBM to support the airline’s overall digital transformation. Finnair is focused on Asia-Europe traffic... Read more
Tech21 Launches Evo Go iPhone 7 Case Availabl...
Tech21 has announced the launch of the Evo Go case for Apple iPhone 7 and iPhone 7 Plus, exclusively at T-Mobile. Available online and at participating T-Mobile stores nationwide, Evo Go cases start... Read more
Apple Turns (RED) with More Ways to Join the...
In recognition of World AIDS Day, Apple is offering more ways than ever for customers to join (RED) in its mission to create an AIDS-free generation. Apple is the worlds largest corporate contributor... Read more

Jobs Board

*Apple* Retail - Multiple Positions- Kansas...
Job Description:SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Retail - Multiple Positions- Chicago...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
Hardware Design Validation Engineer - *Apple...
The Apple Watch team is looking for a Hardware Design Validation Engineer. This person will be part of the Apple Watch hardware team with responsibilities for Read more
SW Engineer *Apple* TV Frameworks - Apple I...
The Apple TV team is looking for a software...create features that reflect the look and feel of Apple TV. Description: Were looking for someone who is Read more
*Apple* Retail - Multiple Positions- Greenwi...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.