Contents

Chapter 1
Introduction

Darcs is a revision control system, along the lines of CVS or arch. That means that it keeps track of various revisions and branches of your project, allows for changes to propagate from one branch to another. Darcs is intended to be an “advanced” revision control system. Darcs has two particularly distinctive features which differ from other revision control systems: 1) each copy of the source is a fully functional branch, and 2) underlying darcs is a consistent and powerful theory of patches.

Every source tree a branch The primary simplifying notion of darcs is that every copy of your source code is a full repository. This is dramatically different from CVS, in which the normal usage is for there to be one central repository from which source code will be checked out. It is closer to the notion of arch, since the ‘normal’ use of arch is for each developer to create his own repository. However, darcs makes it even easier, since simply checking out the code is all it takes to create a new repository. This has several advantages, since you can harness the full power of darcs in any scratch copy of your code, without committing your possibly destabilizing changes to a central repository.

Theory of patches The development of a simplified theory of patches is what originally motivated me to create darcs. This patch formalism means that darcs patches have a set of properties, which make possible manipulations that couldn’t be done in other revision control systems. First, every patch is invertible. Secondly, sequential patches (i.e. patches that are created in sequence, one after the other) can be reordered, although this reordering can fail, which means the second patch is dependent on the first. Thirdly, patches which are in parallel (i.e. both patches were created by modifying identical trees) can be merged, and the result of a set of merges is independent of the order in which the merges are performed. This last property is critical to darcs’ philosophy, as it means that a particular version of a source tree is fully defined by the list of patches that are in it, i.e. there is no issue regarding the order in which merges are performed. For a more thorough discussion of darcs’ theory of patches, see Appendix A.

A simple advanced tool Besides being “advanced” as discussed above, darcs is actually also quite simple. Versioning tools can be seen as three layers. At the foundation is the ability to manipulate changes. On top of that must be placed some kind of database system to keep track of the changes. Finally, at the very top is some sort of distribution system for getting changes from one place to another. Really, only the first of these three layers is of particular interest to me, so the other two are done as simply as possible. At the database layer, darcs just has an ordered list of patches along with the patches themselves, each stored as an individual file. Darcs’ distribution system is strongly inspired by that of arch. Like arch, darcs uses a dumb server, typically apache or just a local or network file system when pulling patches. darcs has built-in support for using ssh to write to a remote file system. A darcs executable is called on the remote system to apply the patches. Arbitrary other transport protocols are supported, through an environment variable describing a command that will run darcs on the remote system. See the documentation for DARCS_APPLY_FOO in Chapter 4 for details.

The recommended method is to send patches through gpg-signed email messages, which has the advantage of being mostly asynchronous.

Keeping track of changes rather than versions In the last paragraph, I explained revision control systems in terms of three layers. One can also look at them as having two distinct uses. One is to provide a history of previous versions. The other is to keep track of changes that are made to the repository, and to allow these changes to be merged and moved from one repository to another. These two uses are distinct, and almost orthogonal, in the sense that a tool can support one of the two uses optimally while providing no support for the other. Darcs is not intended to maintain a history of versions, although it is possible to kludge together such a revision history, either by making each new patch depend on all previous patches, or by tagging regularly. In a sense, this is what the tag feature is for, but the intention is that tagging will be used only to mark particularly notable versions (e.g. released versions, or perhaps versions that pass a time consuming test suite).

Other revision control systems are centered upon the job of keeping track of a history of versions, with the ability to merge changes being added as it was seen that this would be desirable. But the fundamental object remained the versions themselves.

In such a system, a patch (I am using patch here to mean an encapsulated set of changes) is uniquely determined by two trees. Merging changes that are in two trees consists of finding a common parent tree, computing the diffs of each tree with their parent, and then cleverly combining those two diffs and applying the combined diff to the parent tree, possibly at some point in the process allowing human intervention, to allow for fixing up problems in the merge such as conflicts.

In the world of darcs, the source tree is not the fundamental object, but rather the patch is the fundamental object. Rather than a patch being defined in terms of the difference between two trees, a tree is defined as the result of applying a given set of patches to an empty tree. Moreover, these patches may be reordered (unless there are dependencies between the patches involved) without changing the tree. As a result, there is no need to find a common parent when performing a merge. Or, if you like, their common parent is defined by the set of common patches, and may not correspond to any version in the version history.

One useful consequence of darcs’ patch-oriented philosophy is that since a patch need not be uniquely defined by a pair of trees (old and new), we can have several ways of representing the same change, which differ only in how they commute and what the result of merging them is. Of course, creating such a patch will require some sort of user input. This is a Good Thing, since the user creating the patch should be the one forced to think about what he really wants to change, rather than the users merging the patch. An example of this is the token replace patch (See Section A.3.2). This feature makes it possible to create a patch, for example, which changes every instance of the variable “stupidly_named_var” to “better_var_name”, while leaving “other_stupidly_named_var” untouched. When this patch is merged with any other patch involving the “stupidly_named_var”, that instance will also be modified to “better_var_name”. This is in contrast to a more conventional merging method which would not only fail to change new instances of the variable, but would also involve conflicts when merging with any patch that modifies lines containing the variable. By more using additional information about the programmer’s intent, darcs is thus able to make the process of changing a variable name the trivial task that it really is, which is really just a trivial search and replace, modulo tokenizing the code appropriately.

The patch formalism discussed in Appendix A is what makes darcs’ approach possible. In order for a tree to consist of a set of patches, there must be a deterministic merge of any set of patches, regardless of the order in which they must be merged. This requires that one be able to reorder patches. While I don’t know that the patches are required to be invertible as well, my implementation certainly requires invertibility. In particular, invertibility is required to make use of Theorem 2, which is used extensively in the manipulation of merges.

1.1 Features

Record changes locally In darcs, the equivalent of a cvs “commit” is called record, because it doesn’t put the change into any remote or centralized repository. Changes are always recorded locally, meaning no net access is required in order to work on your project and record changes as you make them. Moreover, this means that there is no need for a separate “disconnected operation” mode.

Interactive records You can choose to perform an interactive record, in which case darcs will prompt you for each change you have made and ask if you wish to record it. Of course, you can tell darcs to record all the changes in a given file, or to skip all the changes in a given file, or go back to a previous change, or whatever. There is also an experimental graphical interface, which allows you to view and choose changes even more easily, and in whichever order you like.

Unrecord local changes As a corollary to the “local” nature of the record operation, if a change hasn’t yet been published to the world--that is, if the local repository isn’t accessible by others--you can safely unrecord a change (even if it wasn’t the most recently recorded change) and then re-record it differently, for example if you forgot to add a file, introduced a bug or realized that what you recorded as a single change was really two separate changes.

Interactive everything else Most darcs commands support an interactive interface. The “revert” command, for example, which undoes unrecorded changes has the same interface as record, so you can easily revert just a single change. Pull, push, send and apply all allow you to view and interactively select which changes you wish to pull, push, send or apply.

Test suites Darcs has support for integrating a test suite with a repository. If you choose to use this, you can define a test command (e.g. “make check”) and have darcs run that command on a clean copy of the project either prior to recording a change or prior to applying changes--and to reject changes that cause the test to fail.

Any old server Darcs does not require a specialized server in order to make a repository available for read access. You can use http, ftp, or even just a plain old ssh server to access your darcs repository.

You decide write permissions Darcs doesn’t try to manage write access. That’s your business. Supported push methods include direct ssh access (if you’re willing to give direct ssh access away), using sudo to allow users who already have shell access to only apply changes to the repository, or verification of gpg-signed changes sent by email against a list of allowed keys. In addition, there is good support for submission of patches by email that are not automatically applied, but can easily be applied with a shell escape from a mail reader (this is how I deal with contributions to darcs).

Symmetric repositories Every darcs repository is created equal (well, with the exception of a “partial” repository, which doesn’t contain a full history...), and every working directory has an associated repository. As a result, there is a symmetry between “uploading” and “downloading” changes--you can use the same commands (push or pull) for either purpose.

CGI script Darcs has a CGI script that allows browsing of the repositories.

Portable Darcs runs on UNIX (or UNIX-like) systems (which includes Mac OS X) as well as on Microsoft Windows.

File and directory moves Renames or moves of files and directories, of course are handled properly, so when you rename a file or move it to a different directory, its history is unbroken, and merges with repositories that don’t have the file renamed will work as expected.

Token replace You can use the “darcs replace” command to modify all occurrences of a particular token (defined by a configurable set of characters that are allowed in “tokens”) in a file. This has the advantage that merges with changes that introduce new copies of the old token will have the effect of changing it to the new token--which comes in handy when changing a variable or function name that is used throughout a project.

Configurable defaults You can easily configure the default flags passed to any command on either a per-repository or a per-user basis or a combination thereof.

1.2 Switching from CVS

Darcs is refreshingly different from CVS.

CVS keeps version controlled data in a central repository, and requires that users check out a working directory whenever they wish to access the version-controlled sources. In order to modify the central repository, a user needs to have write access to the central repository; if he doesn’t, CVS merely becomes a tool to get the latest sources.

In darcs there is no distinction between working directories and repositories. In order to work on a project, a user makes a local copy of the repository he wants to work in; he may then harness the full power of version control locally. In order to distribute his changes, a user who has write access can push them to the remote repository; one who doesn’t can simply send them by e-mail in a format that makes them easy to apply on the remote system.

Darcs commands for CVS users Because of the different models used by cvs and darcs, it is difficult to provide a complete equivalence between cvs and darcs. A rough correspondence for the everyday commands follows:

Migrating CVS repositories to darcs Tools and instructions for migrating CVS repositories to darcs are provided on the darcs community website: http://www.scannedinavian.org/DarcsWiki/ConvertingFromCvs ⁰http://www.scannedinavian.org/DarcsWiki/ConvertingFromCvs

1.3 Switching from arch

Although arch, like darcs, is a distributed system, and the two systems have many similarities (both require no special server, for example), their essential organization is very different.

Like CVS, arch keeps data in two types of data structures: repositories (called “archives”) and working directories. In order to modify a repository, one must first check out a corresponding working directory. This requires that users remember a number of different ways of pushing data around -- tla get, update, commit, archive-mirror and so on.

In darcs, on the other hand, there is no distinction between working directories and repositories, and just checking out your sources creates a local copy of a repository. This allows you to harness the full power of version control in any scratch copy of your sources, and also means that there are just two ways to push data around: darcs record, which stores edits into your local repository, and pull, which moves data between repositories. (darcs push is merely the opposite of pull; send and apply are just the two halves of push).

Darcs commands for arch users Because of the different models used by arch and darcs, it is difficult to provide a complete equivalence between arch and darcs. A rough correspondence for the everyday commands follows:

Migrating arch repositories to darcs Tools and instructions for migrating arch repositories to darcs are provided on the darcs community website: http://www.scannedinavian.org/DarcsWiki/ConvertingFromArch ⁰http://www.scannedinavian.org/DarcsWiki/ConvertingFromArch

Chapter 2
Building darcs

This chapter should walk you through the steps necessary to build darcs for yourself. There are in general two ways to build darcs. One is for building released versions from tarballs, and the other is to build the latest and greatest darcs, from the darcs repo itself.

Please let me know if you have any problems building darcs, or don’t have problems described in this chapter and think there’s something obsolete here, so I can keep this page up-to-date.

2.1 Prerequisites

To build darcs you will need to have ghc, the Glorious Glasgow Haskell Compiler. You should have at the very minimum version 6.2.

It is a good idea (but not required) to have a recent version of libcurl installed. If not, you will at least need to have either wget or curl installed if you want to be able to grab repos remotely over normal network protocols (ftp or http). You also might want to have scp available if you want to grab your repos over ssh...

To send patches, you will also need to have a working /usr/sbin/sendmail or /usr/lib/sendmail, which is provided by most mail transport agents, and is generally available on linux and BSD systems. It’s also there on Mac OS X. However, if you don’t have this, it won’t stop you from building darcs.

To use the diff command of darcs, a diff program supporting options -r (recursive diff) and -N (show new files as differences against an empty file) is required. The configure script will look for gdiff, gnudiff and diff in this order. You can force the use of another program by setting the DIFF environment variable before running configure.

To rebuild the documentation (which should not be necessary since it is included in html form with the tarballs), you will need to have latex installed, as well as latex2html if you want to build it in html form.

2.2 Building on Mac OS X

To build on Mac OS X, you will need the Apple Developer Tools and the ghc 6.2 package installed. There seems to be a problem with ghc and Apple’s gcc 3.3, so you may need to run

to avoid crashes. I have also had to run autoconf once when the configure script failed. (NOTE: as of Mac OS X 10.3 and ghc 6.2, it seems that gcc 3.3 works fine, and the above advice is unnecessary.)

Another recently discovered problem is that on MacOS, the curl-config from libcurl versions prior to 7.11.0 gives incorrect link flags, so you probably will want to make sure you have version 7.11.0 installed. I suspect one could also simply edit the curl-config of an older install to remove the offending “-arch i386”, but haven’t tried this.

2.3 Building on Microsoft Windows

To build on Microsoft Windows, you will need:

• MinGW ⁰http://www.mingw.org/ which provides the GCC toolchain for win32.
• MSYS ⁰http://www.mingw.org/msys.shtml which provides a unix build environment for win32. Be sure to download the separate msysDTK, autoconf and automake.
• zlib-1.2.1+ ⁰http://www.gzip.org/zlib/ library and headers.
• curl-7.12.2+ ⁰http://curl.haxx.se/ library and headers.
• If building with an SSL enabled curl you will need the OpenSSL libraries, unofficial builds are available at http://www.slproweb.com/products/Win32OpenSSL.html.

Copy the zlib and curl libraries and headers to both GHC and MinGW. GHC stores C headers in <ghc-dir>/gcc-lib/include and libraries in <ghc-dir>/gcc-lib. MinGW stores headers in <mingw-dir>/include and libraries in <mingw-dir>/lib.

Set PATH to include the <msys-dir>/bin, <mingw-dir>/bin, <curl-dir>, and a directory containing a pre-built darcs.exe if you want the build’s patch context stored for ‘darcs --exact-version’.

2.4 Building from tarball

If you get darcs from a tarball, the procedure (after unpacking the tarball itself) is as follows:

There are options to configure that you may want to check out with

2.5 Building darcs from the repository

To build the latest darcs from its repository, you will first need a working copy of darcs. You can get darcs using:

and once you have the darcs repository you can bring it up to date with a

The repository doesn’t hold automatically generated files, which include the configure script and the HTML documentation, so you need to run autoconf first.

You’ll need autoconf 2.50 or higher. Some systems have more than one version of autoconf installed. For example, autoconf may point to version 2.13, while autoconf259 runs version 2.59.

Also note that make is really ”GNU make”. On some systems, such as the *BSDs, you may need to substitute gmake for this to work.

This also means you’ll need to have latex installed if you want the documentation.

If you want to tweak the configure options, you’ll need to run ./configure yourself after the make, and then run make again.

2.6 Submitting patches to darcs

I know, this doesn’t really belong in this chapter, but if you’re using the repository version of darcs it’s really easy to submit patches to me using darcs. In fact, even if you don’t know any haskell, you could submit fixes or additions to this document (by editing building_darcs.tex) based on your experience building darcs...

To do so, just record your changes (which you made in the darcs repository)

making sure to give the patch a nice descriptive name. The --no-test options keeps darcs from trying to run the unit tests, which can be rather time-consuming. Then you can send the patch to the darcs-devel mailing list by email by

The darcs repository stores the email address to which patches should be sent by default. The email address you see is actually my own, but when darcs notices that you haven’t signed the patch with my GPG key, it will forward the message to darcs-devel.

Chapter 3
Getting started

This chapter will lead you through an example use of darcs, which hopefully will allow you to get started using darcs with your project.

3.1 Creating your repository

Creating your repository in the first place just involves telling darcs to create the special directory (called _darcs) in your project tree, which will hold the revision information. This is done by simply calling from the root directory of your project:

This creates the _darcs directory and populates it with whatever files and directories are needed to describe an empty project. You now need to tell darcs what files and directories in your project should be under revision control. You do this using the command darcs add¹:

When you have added all your files (or at least, think you have), you will want to record your changes. “Recording” always includes adding a note as to why the change was made, or what it does. In this case, we’ll just note that this is the initial version.

Note that since we didn’t specify a patch name on the command line we were prompted for one. If the environment variable ‘EMAIL’ isn’t set, you will also be prompted for your email address. Each patch that is recorded is given a unique identifier consisting of the patch name, its creator’s email address, and the date when it was created.

3.2 Making changes

Now that we have created our repository, make a change to one or more of your files. After making the modification run:

This should show you the modifications that you just made, in the darcs patch format. If you prefer to see your changes in a different format, read Section 6.5.1, which describes the whatsnew command in detail.

Let’s say you have now made a change to your project. The next thing to do is to record a patch. Recording a patch consists of grouping together a set of related changes, and giving them a name. It also tags the patch with the date it was recorded and your email address.

To record a patch simply type:

darcs will then prompt you with all the changes that you have made that have not yet been recorded, asking you which ones you want to include in the new patch. Finally, darcs will ask you for a name for the patch.

You can now rerun whatsnew, and see that indeed the changes you have recorded are no longer marked as new.

3.3 Making your repository visible to others

How do you let the world know about these wonderful changes? Obviously, they must be able to see your repository. Currently the easiest way to do this is typically by http using any web server. The recommended way to do this (using apache in a UNIX environment) is to create a directory called /var/www/repos, and then put a symlink to your repo there:

As long as you’re running a web server and making your repo available to the world, you may as well make it easy for people to see what changes you’ve made. You can do this by running make installserver, which installs the program darcs_cgi at /usr/lib/cgi-bin/darcs. You also will need to create a cache directory named /var/cache/darcs_cgi, and make sure the owner of that directory is the same user that your web server runs its cgi scripts as. For me, this is www-data. Now your friends and enemies should be able to easily browse your repos by pointing their web browsers at http://your.server.org/cgi-bin/darcs. You can read more about this interface in Chapter ??.

3.4 Getting changes made to another repository

Ok, so I can now browse your repository using my web browser... so what? How do I get your changes into my repository, where they can do some good? It couldn’t be easier. I just cd into my repository, and there type:

Darcs will check to see if you have recorded any changes that aren’t in my current repository. If so, it’ll prompt me for each one, to see which ones I want to add to my repository. Note that you may see a different series of prompts depending on your answers, since sometimes one patch depends on another, so if you answer yes to the first one, you won’t be prompted for the second if the first depends on it.

Of course, maybe I don’t even have a copy of your repository. In that case I’d want to do a

which gets the whole repo.

I could instead create an empty repository and fetch all of your patches with pull. Get is just a more efficient way to clone a whole repository.

Get, pull and push also work over ssh. Ssh-paths are of the same form accepted by scp, namely [username@]host:/path/to/repository.

3.5 Moving patches from one repo to another

Darcs is flexible as to how you move patches from one repo to another. This section will introduce all the ways you can get patches from one place to another, starting with the simplest and moving to the most complicated.

3.5.1 All pulls

The simplest method is the “all-pull” method. This involves making each repository readable (by http, ftp, nfs-mounted disk, whatever), and you run ‘darcs pull’ in the repo you want to move the patch to. This is nice, as it doesn’t require you to give write access to anyone else, and is reasonably simple.

3.5.2 Send and apply manually

Sometimes you have a machine on which it is not convenient to set up a web server, perhaps because it’s behind a firewall or perhaps for security reasons, or because it is often turned off. In this case you can use darcs send from that computer to generate a patch bundle destined for another repository. You can either let darcs email the patch for you, or save it as a file and transfer it by hand. Then in the destination repository you (or the owner of that repo) run darcs apply to apply the patches contained in the bundle. This is also quite a simple method since, like the all-pull method, it doesn’t require that you give anyone write access to your repository. But it’s less convenient, since you have to keep track of the patch bundle (in the email, or whatever).

If you use the send and apply method with email, you’ll probably want to create a _darcs/prefs/email file containing your email address. This way anyone who sends to your repository will automatically send the patch bundle to your email address.

If you receive many patches by email, you probably will benefit by running darcs apply directly from your mail program. I have in my .muttrc the following

which allows me to apply patches directly from mutt, sending a confirmation email to the person who sent me the patch.

3.5.3 Push

If you use ssh (and preferably also ssh-agent, so you won’t have to keep retyping your password), you can use the push method to transfer changes (using the scp protocol for communication). This method is again not very complicated, since you presumably already have the ssh permissions set up. Push can also be used when the target repository is local, in which case ssh isn’t needed. On the other hand, in this situation you could as easily run a pull, so there isn’t much benefit.

Note that you can use push to administer a multiple-user repository. You just need to create a user for the repository (or repositories), and give everyone with write access ssh access, perhaps using .ssh/authorized_keys. Then they run

3.5.4 Push --apply-as

Now we get more subtle. If you like the idea in the previous paragraph about creating a repository user to own a repository which is writable by a number of users, you have one other option.

Push --apply-as can run on either a local repository or one accessed with ssh, but uses sudo to run a darcs apply command (having created a patch bundle as in send) as another user. You can add the following line in your sudoers file to allow the users to apply their patches to a centralized repository:

This method is ideal for a centralized repository when all the users have accounts on the same computer, if you don’t want your users to be able to run arbitrary commands as repo-user.

3.5.5 Sending signed patches by email

Most of the previous methods are a bit clumsy if you don’t want to give each person with write access to a repo an account on your server. Darcs send can be configured to send a cryptographically signed patch by email. You can then set up your mail system to have darcs verify that patches were signed by an authorized user and apply them when a patch is received by email. The results of the apply can be returned to the user by email. Unsigned patches (or patches signed by unauthorized users) will be forwarded to the repository owner (or whoever you configure them to be forwarded to...).

This method is especially nice when combined with the --test option of darcs apply, since it allows you to run the test suite (assuming you have one) and reject patches that fail--and it’s all done on the server, so you can happily go on working on your development machine without slowdown while the server runs the tests.

Setting up darcs to run automatically in response to email is by far the most complicated way to get patches from one repo to another... so it’ll take a few sections to explain how to go about it.

Security considerations When you set up darcs to run apply on signed patches, you should assume that a user with write access can write to any file or directory that is writable by the user under which the apply process runs. Unless you specify the --no-test flag to darcs apply (and this is not the default), you are also allowing anyone with write access to that repository to run arbitrary code on your machine (since they can run a test suite--which they can modify however they like). This is quite a potential security hole.

For these reasons, if you don’t implicitly trust your users, it is recommended that you create a user for each repository to limit the damage an attacker can do with access to your repository. When considering who to trust, keep in mind that a security breach on any developer’s machine could give an attacker access to their private key and passphrase, and thus to your repository.

Installing necessary programs You also must install the following programs: gnupg, a mailer configured to receive mail (e.g. exim, sendmail or postfix), and a web server (usually apache). If you want to be able to browse your repository on the web you must also configure your web server to run cgi scripts and make sure the darcs cgi script was properly installed (by either a darcs-server package, or ‘make install-server’).

Setting up a repository with its own user To create a repository, as root run the ‘darcs-createrepo’. You will be prompted for the email address of the repository and the location of an existing copy of the repository. If your desired email is “myproject@my.url”, this will create a user named “myproject” with a home directory of /var/lib/darcs/repos/myproject. FIXME: I have no idea if the darcs-createrepo program will even run on any system other than debian. Success reports would be appreciated (or of course bug reports if it fails).

The “myproject” user will be configured to run the darcs patcher on any emails it receives. However, the patcher will bounce any emails which aren’t signed by a key in the /var/lib/darcs/repos/myproject/allowed_keys gpg keyring (which is empty). To give yourself access to this repository you will need to create a gpg key. If you don’t know about public key cryptography, take a look at the gnupg manual.

Granting access to a repository You create your gpg key by running (as your normal user):

You will be prompted for your name and email address, among other options. To add your public key to the allowed keys keyring. Of course, you can skip this step if you already have a gpg key you wish to use.

You now need to export the public key so we can tell the patcher about it. You can do this with the following command (again as your normal user):

And now we can add your key to the allowed_keys:

You can repeat this process any number of times to authorize multiple users to send patches to the repository.

You should now be able to send a patch to the repository by running as your normal user, in a working copy of the repository:

You may want to add “send sign” to the file _darcs/prefs/defaults so that you won’t need to type --sign every time you want to send...

If your gpg key is protected by a passphrase, then executing send with the --sign option might give you the following error:

The most likely cause of this error is that you have a misconfigured gpg that tries to automatically use a non-existent gpg-agent program. GnuPG will still work without gpg-agent when you try to sign or encrypt your data with a passphrase protected key. However, it will exit with an error code 2 (ENOENT) causing darcs to fail. To fix this, you will need to edit your ~/.gnupg/gpg.conf file and comment out or remove the line that says:

If after commenting out or removing the use-agent line in your gpg configuration file you still get the same error, then you probably have a modified GnuPG with use-agent as a hard-coded option. In that case, you should change use-agent to no-use-agent to disable it explicitly.

Setting up a sendable repository using procmail If you don’t have root access on your machine, or perhaps simply don’t want to bother creating a separate user, you can set up a darcs repository using procmail to filter your mail. I will assume that you already use procmail to filter your email. If not, you will need to read up on it, or perhaps should use a different method for routing the email to darcs. To begin with, you must configure your repository so that a darcs send to your repository will know where to send the email. Do this by creating a file in /path/to/your/repo/_darcs/prefs called email containing your email address. As a trick (to be explained below), we will create the email address with “darcs repo” as your name, in an email address of the form “David Roundy <droundy@abridgegame.org>.”

The next step is to set up a gnupg keyring containing the public keys of people authorized to send to your repo. Here I’ll give a second way of going about this (see above for the first). This time I’ll assume you want to give me write access to your repository. You can do this by:

This works because “D3D5BCEC” is the ID of my gpg key, and I have uploaded my key to the gpg keyservers. Actually, this also requires that you have configured gpg to access a valid keyserver. You can, of course, repeat this command for all keys you want to allow access to.

Finally, we add a few lines to your .procmailrc:

The purpose for the “my darcs repo” trick is partially to make it easier to recognize patches sent to the repository, but is even more crucial to avoid nasty bounce loops by making the --reply option have an email address that won’t go back to the repository. This means that unsigned patches that are sent to your repository will be forwarded to your ordinary email.

I find that I need the “umask 022” in order to keep procmail from setting the umask incorrectly, which causes the repository to no longer be world-readable.

Checking if your e-mail patch was applied After sending a patch with darcs send, you may not receive any feedback, even if the patch is applied. You can confirm whether or not your patch was applied to the remote repo by pointing darcs changes at a remote repo:

That shows you the last 10 changes in the remote repo. You can adjust the options given to changes if a more advanced query is needed.

3.6 Reducing disk space usage

A Darcs repository contains the patches that Darcs uses to store history, the working directory, and a pristine tree (a copy of the working directory files with no local modifications). For large repositories, this can add up to a fair amount of disk usage.

There are two techniques that can be used to reduce the amount of space used by Darcs repositories: linking and using no pristine tree. The former can be used on any repository; the latter is only suitable in special circumstances, as it makes some operations much slower.

3.6.1 Linking between repositories

A number of filesystems support linking files, sharing a single file data between different directories. Under some circumstances, when repositories are very similar (typically because they represent different branches of the same piece of software), Darcs will use linking to avoid storing the same file multiple times.

Whenever you invoke darcs get to copy a repository from a local filesystem onto the same filesystem, Darcs will link patches whenever possible.

In order to save time, darcs get does not link pristine trees even when individual files are identical. Additionally, as you pull patches into trees, patches will become unlinked. This will result in a lot of wasted space if two repositories have been living for a long time but are similar. In such a case, you should relink files between the two repositories.

Relinking is an assymmetric operation: you relink one repository (to which you must have write access) to another repository, called the sibling. This is done with darcs optimize --relink, with -the --sibling flag specyfing the sibling.

The --sibling flag can be repeated multiple times, in which case Darcs will try to find a file to link to in all of the siblings. If a default repository is defined, Darcs will try, as a last resort, to link against the default repository.

3.6.2 Alternate formats for the pristine tree

By default, every Darcs repository contains a complete copy of the pristine tree, the working tree as it would be if there were no local edits. By avoiding the need to consult a possibly large number of patches just to find out if a file is modified, the pristine tree makes a lot of operations much faster than they would otherwise be.

Under some circumstances, keeping a whole pristine tree is not desirable. This is the case when preparing a repository to back up, when publishing a repository on a public web server with limited space, or when storing a repository on floppies or small USB keys. In such cases, it is possible to use a repository with no pristine tree.

Darcs automatically recognises a repository with no pristine tree². In order to create such a tree, specify the --no-pristine-tree flag to darcs initialize or darcs get. There is currently no way to switch an existing repository to use no pristine tree.

The support for --no-pristine-tree repositories is fairly new, and has not been extensively optimised yet. Please let us know if you use this functionality, and which operations you find are too slow.

Chapter 4
Configuring darcs

There are sevaral ways you can adjust darcs’ behavior to suit your needs. The first is to edit files in the _darcs/prefs/ directory of a repository. Such configuration only applies when working with that repository. To configure darcs on a per-user rather than per-repository basis (but with essentially the same methods), you can edit (or create) files in the ~/.darcs/ directory. Finally, the behavior of some darcs commands can be modified by setting appropriate environment variables.

4.1 prefs

The _darcs directory contains a prefs directory. This directory exists simply to hold user configuration settings specific to this repository. The contents of this directory are intended to be modifiable by the user, although in some cases a mistake in such a modification may cause darcs to behave strangely.

defaults Default values for darcs commands can be configured on a per-repository basis by editing (and possibly creating) the _darcs/prefs/defaults file. Each line of this file has the following form:

where COMMAND is either the name of the command to which the default applies, or ALL to indicate that the default applies to all commands accepting that flag. The FLAG term is the name of the long argument option without the “--”, i.e. verbose rather than --verbose. Finally, the VALUE option can be omitted if the flag is one such as verbose that doesn’t involve a value. Each line only takes one flag. To set multiple defaults for the same command (or for ALL commands), use multiple lines.

For example, if your system clock is bizarre, you could instruct darcs to always ignore the file modification times by adding the following line to your _darcs/prefs/defaults file. (Note that this would have to be done for each repository!)

If you never want to run a test when recording to a particular repository (but still want to do so when running check on that repo), and like to name all your patches “Stupid patch”, you could use the following:

There are some options which are meant specifically for use in _darcs/prefs/defaults. One of them is --disable. As the name suggests, this option will disable every command that got it as argument. So, if you are afraid that you could damage your repositories by inadvertant use of a command like amend-record, add the following line to _darcs/prefs/defaults:

Also, a global preferences file can be created with the name .darcs/defaults in your home directory. Options present there will be added to the repository-specific preferences. If they conflict with repository-specific options, the repository-specific ones will take precedence.

repos The _darcs/prefs/repos file contains a list of repositories you have pulled from or pushed to, and is used for autocompletion of pull and push commands in bash. Feel free to delete any lines from this list that might get in there, or to delete the file as a whole.

author The _darcs/prefs/author file contains the email address (or name) to be used as the author when patches are recorded in this repository, e.g. “David Roundy ¡droundy@abridgegame.org¿”. This file overrides the contents of the environment variables $DARCS_EMAIL and $EMAIL.

boring The _darcs/prefs/boring file may contain a list of regular expressions describing files, such as object files, that you do not expect to add to your project. As an example, the boring file that I use with my darcs repository is:

The last line is actually irrelevant because I don’t use CVS, but if I did it would be handy. A newly created repository has a longer boring file that includes many common source control, backup, temporary, and compiled files.

You may want to have the boring file under version control. To do this you can use darcs setpref to set the value “boringfile” to the name of your desired boring file (e.g. “darcs setpref boringfile .boring”, where .boring is the repository path of a file that has been darcs added to your repository). The boringfile pref overrides _darcs/prefs/boring, so be sure to copy that file to the boringfile.

You can also set up a “boring” regexps file in your home directory, named ~/.darcs/boring, which will be used with all of your darcs repositories.

Any file whose repository path (such as manual/index.html) matches any of the boring regular expressions is considered boring. The boring file is used to filter the files provided to darcs add, to allow you to use a simple “darcs add newdir newdir/*” without accidentally adding a bunch of object files. It is also used when the --look-for-adds flag is given to whatsnew or record.

binaries The _darcs/prefs/binaries file may contain a list of regular expressions describing files that should be treated as binary files rather than text files. You probably will want to have the binaries file under version control. To do this you can use darcs setpref to set the value “binariesfile” to the name of your desired binaries file (e.g. “darcs setpref binariesfile ./.binaries”, where .binaries is a file that has been darcs added to your repository). As with the boring file, you can also set up a ~/.darcs/binaries file if you like.

4.2 Environment variables

There are a few environment variables whose contents affect darcs’ behavior.

DARCS_EMAIL The DARCS_EMAIL environment variable determines the “author” name used by darcs when recording if no _darcs/prefs/author exists. If DARCS_EMAIL is undefined, the contents of the EMAIL environment variable are used.

DARCS_EDITOR When pulling up an editor (for example, when adding a long comment in record), darcs uses the contents of DARCS_EDITOR if it is defined. If not, it tries the contents of VISUAL, and if that isn’t defined (or fails for some reason), it tries EDITOR. If none of those environment variables are defined, darcs tries vi, emacs, emacs -nw and nano in that order.

DARCS_TMPDIR If the environment variable DARCS_TMPDIR is defined, darcs will use that directory for its temporaries. Otherwise it will use TMPDIR, if that is defined, and if not that then /tmp and if /tmp doesn’t exist, it’ll put the temporaries in _darcs.

This is very helpful, for example, when recording with a test suite that uses MPI, in which case using /tmp to hold the test copy is no good, as /tmp isn’t shared over NFS and thus the mpirun call will fail, since the binary isn’t present on the compute nodes.

HOME HOME is used to find the per-user prefs directory, which is located at $HOME/.darcs.

TERM If darcs is compiled with libcurses support and support for color output, it uses the environment variable TERM to decide whether or not color is supported on the output terminal.

SSH_PORT When using ssh, if the SSH_PORT environment variable is defined, darcs will use that port rather than the default ssh port (which is 22).

DARCS_SSH The DARCS_SSH environment variable defines the command that darcs will use when asked to run ssh. This command is not interpreted by a shell, so you cannot use shell metacharacters, and the first word in the command must be the name of an executable located in your path.

DARCS_SCP and DARCS_SFTP The DARCS_SCP and DARCS_SFTP environment variables define the commands that darcs will use when asked to run scp or sftp. Note that scp and sftp is how darcs accesses repositories whose URL is of the form user@foo.org:foo or foo.org:foo. Darcs will use scp to copy single files (e.g. repository meta-information), and sftp to copy multiple files in batches (e.g. patches). These commands are not interpreted by a shell, so you cannot use shell metacharacters, and the first word in the command must be the name of an executable located in your path.

DARCS_PROXYUSERPWD This environment variable allows DARCS and libcurl to access remote repositories via a password-protected HTTP proxy. The proxy itself is specified with the standard environment variable for this purpose, namely ’http_proxy’. The DARCS_PROXYUSERPWD environment variable specifies the proxy username and password. It must be given in the form username:password.

DARCS_USE_ISPRINT There is currently no way to specify the character encoding of a darcs repository, so darcs will by default print everything that is not printable ASCII characters as hexadecimal escape codes. This protects the terminal from (possibly malicious) control codes. If the repository is encoded in the system’s locale and it is an 8-bit, single-byte encoding, (e.g. ISO 8859-1), darcs can use the library function isPrint to check for printable characters, including non-ASCII. Setting the environment variable DARCS_USE_ISPRINT=1 enables this. It does not work for multi-byte encodings like UTF-8.

DARCS_GET_FOO, DARCS_MGET_FOO and DARCS_APPLY_FOO When trying to access a repository with a url beginning foo://, darcs will invoke the program specified by the DARCS_GET_FOO environment variable (if defined) to download each file, and the command specified by the DARCS_APPLY_FOO environment variable (if defined) when pushing to a foo:// url. This method overrides all other ways of getting foo://xxx urls.

Note that each command should be constructed so that it sends the downloaded content to STDOUT, and the next argument to it should be the URL. Here are some examples that should work for DARCS_GET_HTTP:

If set, DARCS_MGET_FOO will be used to fetch many files from a single repository simultaneously. Replace FOO and foo as appropriate to handle other URL schemes. These commands are not interpreted by a shell, so you cannot use shell metacharacters, and the first word in the command must be the name of an executable located in your path. The GET command will be called with a url for each file, the MGET command will be invoked with a number of urls and is expected to download the files to the current directory, preserving the filename but not the path, the APPLY command will be called with a darcs patchfile piped into its standard input. Example:

DARCS_MGETMAX When invoking a DARCS_MGET_FOO command, darcs will limit the number of urls presented to the command to the value of this variable, if set, or 200.

DARCS_WGET This is a very old option that is only used if libcurl is not compiled in and one of the DARCS_GET_FOO is not used. Using one of those is recommended instead.

The DARCS_WGET environment variable defines the command that darcs will use to fetch all URLs for remote repositories. The first word in the command must be the name of an executable located in your path. Extra arguments can be included as well, such as:

Darcs will append -i to the argument list, which it uses to provide a list of URLS to download. This allows wget to download multiple patches at the same time. It’s possible to use another command besides wget with this environment variable, but it must support the -i option in the same way.

These commands are not interpreted by a shell, so you cannot use shell meta-characters.

Chapter 5
Best practices

5.1 Introduction

This chapter is intended to review various scenarios and describe in each case effective ways of using darcs. There is no one “best practice”, and darcs is a sufficiently low-level tool that there are many high-level ways one can use it, which can be confusing to new users. The plan (and hope) is that various users will contribute here describing how they use darcs in different environments. However, this is not a wiki, and contributions will be edited and reviewed for consistency and wisdom.

5.2 Basics

This section will lay down the concepts around which darcs functions. The aim is to develop a way of thinking that corresponds well to how darcs is behaving -- even in complicated situations.

Darcs is change based. Changes are recorded in patches. Patches are copied to other branches to incorporate the changes there. Patches can be thrown away to make a branch go back in time. Patches are, as much as possible, independent; you can include some patches but exclude others in a branch. This can be used to find out exactly what patch introduced a bug.

5.2.1 Creating patches

In a single darcs repository you can think of two “versions” of the source tree. They are called the working and pristine trees. Working is your normal source tree, with or without darcs alongside. The only thing that makes it part of a darcs repository is the _darcs directory in its root. Pristine is the recorded state of the source tree. The pristine tree is constructed from groups of changes, called patches (some other version control use the term changeset instead of patch).footnoteIf you look inside _darcs you will find files or directories named ‘patches’ and ‘inventories’, which store all the patches ever recorded. If the repository holds a cached pristine tree, it is stored in a directory called pristine or current; otherwise, the fact that there is no prisine tree is marked by the presence of a file called pristine.none or current.none.

Changes

If working and pristine are the same, there are “no changes” in the repository. Changes can be introduced (or removed) by editing the files in working. They can also be caused by darcs commands, which can modify both working and pristine. It is important to understand for each darcs command how it modifies working, pristine or both of them.

whatsnew (as well as diff) can show the difference between working and pristine to you. It will be shown as a difference in working. In advanced cases it need not be working that has changed; it can just as well have been pristine, or both. The important thing is the difference and what darcs can do with it.

Keeping or discarding changes

If you have a difference in working, you do two things with it: record it to keep it, or revert it to lose the changes.¹

If you have a difference between working and pristine--for example after editing some files in working--whatsnew will show some “unrecorded changes”. To save these changes, use record. It will create a new patch in pristine with the same changes, so working and pristine are no longer different. To instead undo the changes in working, use revert. It will modify the files in working to be the same as in pristine (where the changes do not exist).

Unrecording changes

unrecord is a command meant to be run only in private repositories. It’s intention is to allow developers the flexibility to undo patches that haven’t been distributed yet.

However, darcs does not prevent you from unrecording a patch that has been copied to another repository. Be aware of this danger!

If you unrecord a patch, that patch will be deleted from pristine. This will cause working to be different from pristine, and whatsnew to report unrecorded changes. The difference will be the same as just before that patch was recorded. Think about it. record examines what’s different with working and constructs a patch with the same changes in pristine so they are no longer different. unrecord deletes this patch; the changes in pristine disappear and the difference is back.

If the recorded changes included an error, the resulting flawed patch can be unrecorded. When the changes have been fixed, they can be recorded again as a new--hopefully flawless--patch.

If the whole change was wrong it can be discarded from working too, with revert. revert will update working to the state of pristine, in which the changes do no longer exist after the patch was deleted.

Keep in mind that the patches are your history, so deleting them with unrecord makes it impossible to track what changes you really made. Redoing the patches is how you “cover the tracks”. On the other hand, it can be a very convenient way to manage and organize changes while you try them out in your private repository. When all is ready for shipping, the changes can be reorganized in what seems as useful and impressive patches. Use it with care.

All patches are global, so don’t ever replace an already “shipped” patch in this way! If an erroneous patch is deleted and replaced with a better one, you have to replace it in all repositories that have a copy of it. This may not be feasible, unless it’s all private repositories. If other developers have already made patches or tags in their repositories that depend on the old patch, things will get complicated.

Special patches and pending

Write me!

5.2.2 Using patches

Write me!

5.3 Distributed development with one primary developer

This is how darcs itself is developed. There are many contributors to darcs, but every contribution is reviewed and manually applied by myself. For this sort of a situation, ’darcs send’ is ideal, since the barrier for contributions is very low, which helps encourage contributors.

One could simply set the _darcs/prefs/email value to the project mailing list, but I also use darcs send to send my changes to the main server, so instead the email address is set to “Davids Darcs Repo <droundy@abridgegame.org>”. My .procmailrc file on the server has the following rule:

This causes darcs apply to be run on any emails sent to “Davids Darcs Repo”. Apply actually applies them only if they are signed by an authorized key. Currently, the only authorized key is mine, but of course this could be extended easily enough.

The central darcs repository contains the following values in its _darcs/prefs/defaults:

The first line tells apply to always run the test suite. The test suite is in fact the main reason I use send rather than push, since it allows me to easily continue working (or put my computer to sleep) while the tests are being run on the main server. The second line is just there to improve the email response that I get when a patch has either been applied or failed the tests. The third line makes darcs not complain about unsigned patches, but just to forward them to darcs-devel.

On my development computer, I have in my .muttrc the following alias, which allows me to easily apply patches that I get via email directly to my darcs working directory:

5.4 Development by a small group of developers in one office

This section describes the development method used for the density functional theory code DFT++, which is available at http://dft.physics.cornell.edu/dft.

We have a number of workstations which all mount the same /home via NFS. We created a special “dft” user, with the central repository living in that user’s home directory. The ssh public keys of authorized persons are added to the “dft” user’s .ssh/allowed_keys, and we commit patches to this repository using darcs push. As in Section 5.3, we have the central repository set to run the test suite before the push goes through.

Note that no one ever runs as the dft user.

A subtlety that we ran into showed up in the running of the test suite. Since our test suite includes the running of MPI programs, it must be run in a directory that is mounted across our cluster. To achieve this, we set the $DARCS_TMPDIR environment variable to ~/tmp.

Note that even though there are only four active developers at the moment, the distributed nature of darcs still plays a large role. Each developer works on a feature until it is stable, a process that often takes quite a few patches, and only once it is stable pushes to the central repo.

Chapter 6
Darcs commands

The general format of a darcs command is

Here COMMAND is a command such as add or record, which of course may have one or more arguments. Options have the form --option or -o, while arguments vary from command to command. There are many options which are common to a number of different commands, which will be summarized here.

If you wish, you may use any unambiguous beginning of a command name as a shortcut: for darcs record, you could type darcs recor or darcs rec, but not darcs re since that could be confused with darcs replace, darcs revert and darcs remove.

Command overview Not all commands modify the ”patches” of your repository (that is, the named patches which other users can pull), some commands only affect the copy of the source tree you’re working on (your ”working directory”), and some affect both. This table summarizes what you should expect from each one and will hopefully serve as guide when you’re having doubts about which command to use.

6.1 Common options to darcs commands

Every COMMAND accepts --help as an argument, which tells it to provide a bit of help. Among other things, this help always provides an accurate listing of the options available with that command, and is guaranteed never to be out of sync with the version of darcs you actually have installed (unlike this manual, which could be for an entirely different version of darcs).

Every COMMAND accepts the --disable option, which can be used in _darcs/prefs/defaults to disable some commands in the repository. This can be helpful if you want to protect the repository from accidential use of advanced commands like unpull, unrecord or amend-record.

Most commands also accept the --verbose option, which tells darcs to provide additional output. The amount of verbosity varies from command to command.

Another common option is the --repodir option, which allows you to specify the directory of the repository in which to perform the command. This option is used with commands, such as whatsnew, that ordinarily would be performed within a repository directory, and allows you to use those commands without actually being in the repo directory when calling the command. This is useful when running darcs as a pipe, as might be the case when running apply from a mailer.

Selecting patches Many commands operate on a patch or patches that have already been recorded. There are a number of options that specify which patches are selected for these operations: --patch, --match, --tag, and variants on these, which for --patch are --patches, --from-patch, and --to-patch. The --patch and --tag forms simply take (POSIX extended, aka egrep) regular expressions and match them against tag and patch names. --match, described below, allows more powerful patterns.

The plural forms of these options select all matching patches. The singular forms select the last matching patch. The range (from and to) forms select patches after (exclusive) or up to (inclusive) the last matching patch.

These options use the current order of patches in the repository. darcs may reorder patches, so this is not necessarily the order of creation or the order in which patches were applied. However, as long as you are just recording patches in your own repository, they will remain in order.

Match Currently --match accepts three primitive match types, although there are plans to expand it to match more patterns. Also, note that the syntax is still preliminary and subject to change.

The first match type accepts a regular expression which is checked against the patch name. The syntax is

If you want to include spaces in the regular expression, it must be enclosed in double quotes (‘”’), and currently there is no provision for escaping a double quote, so you have to choose between matching double quotes and matching spaces.

The second match type matches the darcs hash for each patch:

This is intended to be used, for example, by programs allowing you to view darcs repositories (e.g. cgi scripts like viewCVS).

There is also now rudimentary support for matching by date. This is done using commands such as

currently date matching always matches only the day itself. FIXME: It should be extended to match the time as well if the time is specified. In general, a lot of cleanup is needed in the date matching code.

Because the date matching is only by day, you may prefer to combine it with a more specific pattern.

The --match pattern can include the logical operators &&, || and not, as well as grouping of patterns with parentheses. For example

Darcs optimizes its operations by keeping track of the modification times of your files. This dramatically speeds up commands such as whatsnew and record which would otherwise require reading every file in the repo and comparing it with a reference version. However, there are times when this can cause problems, such as when running a series of darcs commands from a script, in which case often a file will be modified twice in the same second, which can lead to the second modification going unnoticed. The solution to such predicaments is the --ignore-times option, which instructs darcs not to trust the file modification times, but instead to check each file’s contents explicitly.

Several commands need to be able to identify you. Conventionally, you provide an email address for this purpose, which can include comments, e.g. “David Roundy ¡droundy@abridgegame.org¿”. The easiest way to do this is to define an environment variable EMAIL or DARCS_EMAIL (with the latter overriding the former). You can also override this using the --author flag to any command. Alternatively, you could set your email address on a per-repository basis using the “defaults” mechanism for “ALL” commands, as described in Appendix B. Or, you could specify the author on a per-repository basis using the _darcs/prefs/author file as described in section 4.1.

Also, a global author file can be created with the name .darcs/author in your home directory. This file overrides the contents of the environment variables, but a repository-specific author file overrides the global author file.

By default, darcs commands that write patches to disk will compress the patch files. If you don’t want this, you can choose the --dont-compress option, which causes darcs not to compress the patch file.

Certain commands may have an optional graphical user interface. If such commands are supported, you can activate the graphical user interface by calling darcs with the --gui flag.

The --dry-run option will cause darcs to not actually take the specified action. but only print what would have happened. Not all commands accept --dry-run, but those that do should accept the --summary option.

The --summary show a summary of the patches that would have been pulled/pushed/whatever. The format is similar to the output format of cvs update and looks like this:

You can probably guess what the flags mean from the clever file names.

A is for files that have been added but not recorded yet. a is for files found using the --look-for-adds option available for whatsnew and record. They have not been added yet, but would be added automatically if --look-for-adds were used with the next record command.

M is for files that have been modified in the working directory but not recorded yet. The number of added and subtracted lines is also shown.

R is for files that have been removed, but the removal is not recorded yet.

An explanation mark appears next to any option that has a conflict.

Resolution of conflicts To resolve conflicts using an external tool, you need to specify a command to use, e.g.

The %1 and %2 are replaced with the two versions to be merged, %a is replaced with the common ancestor of the two version. Most importantly, %o is replaced with the name of the output file that darcs will require to be created holding the merged version. The above example works with the FileMerge.app tool that comes with Apple’s developer tools. To use xxdiff, you would use

To use kdiff3, you can use

If you figure out how to use darcs with another merge tool, please let me know what flags you used so I can mention it here.

Note that if you do use an external merge tool, most likely you will want to your defaults file _darcs/prefs/defaults (see 4.1) a line such as

Note that the defaults file does not want quotes around the command.

Options apart from darcs commands Calling darcs with just “--help” as an argument gives a brief summary of what commands are available. The “--extended-help” option gives a more technical summary of what the commands actually do. Calling darcs with the flag “--version” tells you the version of darcs you are using. Calling darcs with the flag “--exact-version” gives the precise version of darcs, even if that version doesn’t correspond to a released version number. This is helpful with bug reports, especially when running with a “latest” version of darcs. Similarly calling darcs with only “--commands” gives a simple list of available commands. This latter arrangement is primarily intended for the use of command-line autocompletion facilities, as are available in bash.

6.2 Creating repositories

6.2.1 darcs initialize

Usage: darcs initialize [OPTION]... 

Options:

Initialize a new source tree as a darcs repository.

Generally you will only call initialize once for each project you work on, and calling it is just about the first thing you do. Just make sure you are in the main directory of the project, and initialize will set up all the directories and files darcs needs in order to start keeping track of revisions for your project.

initialize actually follows a very simple procedure. It simply creates the directories _darcs, _darcs/current (or _darcs/pristine) and _darcs/patches, and then creates an empty file, _darcs/inventory. However, it is strongly recommended that you use darcs initialize to do this, as this procedure may change in a future version of darcs.

In order to save disk space, you can use initialize with the --no-pristine-tree flag to create a repository with no pristine tree. Please see Section 3.6 for more information.

6.2.2 darcs get

Usage: darcs get [OPTION]... <REPOSITORY> [<DIRECTORY>]

Options:

Get is used to get a local copy of a repository. I recommend using the --verbose flag to get, as this command can take a while, and with no feedback, that can be rather boring.

If the remote repo and the current directory are in the same filesystem and that filesystem supports hard links, get will create hard links for the patch files, which means that the additional storage space needed will be minimal. This is very good for your disk usage (and for the speed of running get), so if you want multiple copies of a repository, I strongly recommend first running darcs get to get yourself one copy, and then running darcs get on that copy to make any more you like. The only catch is that the first time you run darcs push or darcs pull from any of these second copies, by default they will access your first copy--which may not be what you want.

You may specify the name of the repository created by providing a second argument to get, which is a directory name.

If you want to get a specific version of a repository, you have a few options. You can either use the --tag, --to-patch or --to-match options, or you can use the --context=FILENAME option, which specifies a file containing a context generated with darcs changes --context. This allows you (for example) to include in your compiled program an option to output the precise version of the repository from which it was generated, and then perhaps ask users to include this information in bug reports.

Note that when specifying --to-patch or --to-match, you may get a version of your code that has never before been seen, if the patches have gotten themselves reordered. If you ever want to be able to precisely reproduce a given version, you need either to tag it or create a context file.

Only get the patches since the last checkpoint. This will save time, bandwidth and disk space, at the expense of losing the history before the checkpoint.

In order to save disk space, you can use get with the --no-pristine-tree flag to create a repository with no pristine tree. Please see Section 3.6 for more information.

6.3 Modifying the contents of a repo

6.3.1 darcs add

Usage: darcs add [OPTION]... <FILE or DIRECTORY> ...

Options:

Add needs to be called whenever you add a new file or directory to your project. Of course, it also needs to be called when you first create the project, to let darcs know which files should be kept track of.

Darcs will refuse to add a file or directory that differs from an existing one only in case. This is because the HFS+ file system used on under MacOS treats such files as being one and the same.

The --date-trick option allows you to enable an experimental trick to make add conflicts, in which two users each add a file or directory with the same name, less problematic. While this trick is completely safe, it is not clear to what extent it is beneficial.

6.3.2 darcs remove

Usage: darcs remove [OPTION]... <FILE or DIRECTORY> ...

Options:

Remove should be called when you want to remove a file from your project, but don’t actually want to delete the file. Otherwise just delete the file or directory, and darcs will notice that it has been removed. Be aware that the file WILL be deleted from any other copy of the repo to which you later apply the patch.

6.3.3 darcs mv

Usage: darcs mv [OPTION]... <FILE or DIRECTORY> ...

Options:

Darcs mv needs to be called whenever you want to rename or move a file or directory. Unlike remove, mv actually performs the move itself in your working directory. This is why “mv” isn’t called “move”, since it is really almost equivalent to the unix command “mv”. I could add an equivalent command named “move” for those who like vowels.

Darcs mv will by default refuse to rename a file if there already exists a file having the same name apart from case. This is because doing so could create a repository that could not be used on file systems that are case insensitive (such as Apples HFS+). You can override this by with the flag --case-ok.

6.3.4 darcs replace

Usage: darcs replace [OPTION]... <OLD> <NEW> <FILE> ...

Options:

Replace allows you to change a specified token wherever it occurs in the specified files. Tokens here are defined by a regexp specifying the characters which are allowed. By default a token corresponds to a C identifier.

The default regexp is [A-Za-z_0-9]), and if one of your tokens contains a ‘-’ or ‘.’, you will then (by default) get the “filename” regexp, which is [A-Za-z_0-9\-\.].

If you prefer to choose a different set of characters to define your token (perhaps because you are programming in some other language), you may do so with the --token-chars option. You may prefer to define tokens in terms of delimiting characters instead of allowed characters using a flag such as --token-chars '[^ \n\t]', which would define a token as being white-space delimited.

If you do choose a non-default token definition, I recommend using _darcs/prefs/defaults to always specify the same --token-chars, since your replace patches will be better behaved (in terms of commutation and merges) if they have tokens defined in the same way.

When using darcs replace, the “new” token may not already appear in the file--if that is the case, the replace change would not be invertible. This limitation holds only on the already-recorded version of the file.

There is a potentially confusing difference, however, when a replace is used to make another replace possible:

will be valid, even if newtoken and oldtoken are both present in the recorded version of foo.c, while the sequence

will fail because “newtoken” still exists in the recorded version of foo.c. The reason for the difference is that when recording, a “replace” patch always is recorded before any manual changes, which is usually what you want, since often you will introduce new occurrences of the “newtoken” in your manual changes. In contrast, “replace” changes are recorded in the order in which they were made.

6.4 Working with changes

6.4.1 darcs record

Usage: darcs record [OPTION]... [FILE or DIRECTORY]...

Options:

Record is used to name a set of changes and record the patch to the repository. If you provide one or more files or directories as additional arguments to record, you will only be prompted to changes in those files or directories. Each patch is given a name, which typically would consist of a brief description of the changes. This name is later used to describe the patch. The name must fit on one line (i.e. cannot have any embedded newlines). If you have more to say, stick it in the log. The patch is also flagged with the author of the change, taken by default from the DARCS_EMAIL environment variable, and if that doesn’t exist, from the EMAIL environment variable. The date on which the patch was recorded is also included. Currently there is no provision for keeping track of when a patch enters a given repository. Finally, each changeset should have a full log (which may be empty). This log is for detailed notes which are too lengthy to fit in the name. If you answer that you do want to create a comment file, darcs will open an editor so that you can enter the comment in. The choice of editor proceeds as follows. If one of the $DARCS_EDITOR, $VISUAL or $EDITOR environment variables is defined, its value is used (with precedence proceeding in the order listed). If not, “vi”, “emacs”, “emacs -nw” and “nano” are tried in that order.

There is a problem that shows up with at least some versions of vi which keep them from working properly with darcs. An (ugly) solution to this is to tell vi to use the tty as stdin and stdout:

If you wish, you may specify the patch name and log using the --logfile flag. If you do so, the first line of the specified file will be taken to be the patch name, and the remainder will be the “long comment”. This feature can be especially handy if you have a test that fails several times on the record (thus aborting the record), so you don’t have to type in the long comment multiple times. The file’s contents will override the --patch-name option.

Each patch may depend on any number of previous patches. If you choose to make your patch depend on a previous patch, that patch is required to be applied before your patch can be applied to a repo. This can be used, for example, if a piece of code requires a function to be defined, which was defined in an earlier patch.

If you want to manually define any dependencies for your patch, you can use the --ask-deps flag, and darcs will ask you for the patch’s dependencies.

If you configure darcs to run a test suite, darcs will run this test on the recorded repo to make sure it is valid. Darcs first creates a pristine copy of the source tree (in a temporary directory), then it runs the test, using its return value to decide if the record is valid. If it is not valid, the record will be aborted. This is a handy way to avoid making stupid mistakes like forgetting to ‘darcs add’ a new file. It also can be tediously slow, so there is an option (--no-test) to skip the test.

If you run record with the --pipe option, you will be prompted for the patch name, patch date and the long comment. The long comment will extend until the end of file of stdin is reached (ctrl-D on unixy systems). This interface is intended for scripting darcs, in particular for writing repository conversion scripts. The prompts are intended mostly as useful guide (since scripts won’t need them), to help you understand the format in which to provide the input.

By default, record works interactively. Probably you only thing you need to know about using this is that you can press ? at the prompt to be shown a list of the rest the options and what they do. The rest should be clear from there. Here’s a ’screenshot’ to demonstrate:

What you can’t see in that ’screenshot’ is that darcs will also try to use color in your terminal to make the output even easier to read.

6.4.2 darcs pull

Usage: darcs pull [OPTION]... [REPOSITORY]

Options:

Pull is used to bring changes made in another repo into the current repo (that is, either the one in the current directory, or the one specified with the -repodir option). Pull allows you to bring over all or some of the patches that are in that repo but not in the current one. Pull accepts an argument, which is the URL from which to pull, and when called without an argument, pull will use the repository from which you have most recently either pushed or pulled.

You can use an external interactive merge tool to resolve conflicts with the flag --external-merge. For more details see subsection 6.1.

The --patches, --matches, and --tags options can be used to select which patches to pull, as described in subsection 6.1. darcs will silently pull along any other patches upon which the selected patches depend. So --patches bugfix means “pull all the patches with ‘bugfix’ in their name, along with any patches they require.” If you really only want the patches with ‘bugfix’ in their name, you should use the --no-deps option, which makes darcs pull in only the selected patches which have no dependencies (apart from other selected patches).

If you specify the --test option, pull will run the test (if a test exists) on a scratch copy of the repo contents prior to actually performing the pull. If the test fails, the pull will be aborted.

Adding the --verbose option causes another section to appear in the output which also displays a summary of patches that you have and the remote repo lacks. Thus, the following syntax can be used to show you all the patch differences between two repos:

6.4.3 darcs push

Usage: darcs push [OPTION]... [REPOSITORY]

Options:

Push is the opposite of pull. Push allows you to move changes from the current repository into another repository.

For obvious reasons, you can only push to repositories to which you have write access. In addition, you can only push to repos that you access either on the local file system or with ssh. In order to apply with ssh, darcs must also be installed on the remote computer. The command invoked to run ssh may be configured by the DARCS_SSH environment variable (see subsection 4.2). The command invoked via ssh is always darcs, i.e., the darcs executable must be in the default path on the remote machine.

Push works by creating a patch bundle, and then running darcs apply in the target repository using that patch bundle. This means that the default options for apply in the target repository (such as, for example, --test) will affect the behavior of push. This also means that push is somewhat less efficient than pull.

When you receive an error message such as

then this means that the darcs on the remote machine could not be started. Make sure that the darcs executable is called darcs and is found in the default path. The default path can be different in interactive and in non-interactive shells. Say

to try whether the remote darcs can be found, or

(note the single quotes) to check the default path.

If you give the --apply-as flag, darcs will use sudo to apply the changes as a different user. This can be useful if you want to set up a system where several users can modify the same repository, but you don’t want to allow them full write access. This isn’t secure against skilled malicious attackers, but at least can protect your repository from clumsy, inept or lazy users.

The --patches, --matches, and --tags options can be used to select which patches to push, as described in subsection 6.1. darcs will silently push along any other patches upon which the selected patches depend.

When there are conflicts, the behavior of push is determined by the default flags to apply in the target repository. Most commonly, for pushed-to repositories, you’d like to have --dont-allow-conflicts as a default option to apply (by default, it is alreay the default...). If this is the case, when there are conflicts on push, darcs will fail with an error message. You can then resolve by pulling the conflicting patch, recording a resolution and then pushing the resolution together with the conflicting patch.

Darcs does not have an explict way to tell you which patch conflicted, only the file name. You may want to pull all the patches from the remote repo just to be sure. If you don’t want to do this in your working directory, you can create another darcs working directory for this purpose.

If you want, you could set the target repo to use --allow-conflicts. In this case conflicting patches will be applied, but the conflicts will not be marked in the working directory.

If, on the other hand, you have --mark-conflicts specified as a default flag for apply in the target repository, when there is a conflict, it will be marked in the working directory of the target repository. In this case, you should resolve the conflict in the target repository itself.

6.4.4 darcs send

Usage: darcs send [OPTION]... [REPOSITORY]

Options:

Send is used to prepare a bundle of patches that can be applied to a target repository. Send accepts the URL of the repository as an argument. When called without an argument, send will use the most recent repository that was either pushed to, pulled from or sent to. By default, the patch bundle is sent by email, although you may save it to a file.

If you want to create a patches having context, you can use the --unified option, which create output vaguely reminiscent of diff -u. This format is still darcs-specific and should not be expected to apply cleanly by patch.

The --output and --to flags determine what darcs does with the patch bundle after creating it. If you provide an --output argument, the patch bundle is saved to that file. If you give one or more --to arguments, the bundle of patches is emailed to those addresses.

If you don’t provide either a --output or a --to flag, darcs will look at the contents of the _darcs/prefs/email file in the target repository (if it exists), and send the patch by email to that address. In this case, you may use the --cc option to specify additional recipients without overriding the default repository email address.

If there is no email address associated with the repository, darcs will prompt you for an email address.

The --patches, --matches, and --tags options can be used to select which patches to send, as described in subsection 6.1. darcs will silently send along any other patches upon which the selected patches depend.

If you want to include a description or explanation along with the bundle of patches, you need to specify the --edit-description flag, which will cause darcs to open up an editor with which you can compose an email to go along with your patches.

6.4.5 darcs apply

Usage: darcs apply [OPTION]... <PATCHFILE>

Options:

Apply is used to apply a bundle of patches to this repository. Such a bundle may be created using send.

Darcs apply accepts a single argument, which is the name of the patch file to be applied. If you omit this argument, the patch is read from standard input.³ This allows you to use apply with a pipe from your email program, for example.

If you specify the --verify PUBRING option, darcs will check that the patch was gpg-signed by a key which is in PUBRING, and will refuse to apply the patch otherwise.

If you give the --reply FROM option to darcs apply, it will send the results of the application to the sender of the patch. This only works if the patch is in the form of an email with its headers intact, so that darcs can actually know the origin of the patch. The reply email will indicate whether or not the patch was successfully applied. The FROM flag is the email address that will be used as the “from” address when replying. If the darcs apply is being done automatically, it is important that this address not be the same as the address at which the patch was received in order to avoid automatic email loops.

If you want to also send the apply email to another address (for example, to create something like a “commits” mailing list), you can use the --cc option to specify additional recipients. Note that the --cc option requires the --reply option, which provides the “From” address.

The --reply feature of apply is intended primarily for two uses. When used by itself, it is handy for when you want to apply patches sent to you by other developers so that they will know when their patch has been applied. For example, in my .muttrc (the config file for my mailer) I have:

which allows me to apply a patch to darcs directly from my mailer, with the originator of that patch being sent a confirmation when the patch is successfully applied. NOTE: For some reason mutt seems to set the umask such that patches created with the above macro are not world-readable. I’m not sure why this is, but use it with care.

When used in combination with the --verify option, the --reply option allows for a nice pushable repository. When these two options are used together, any patches that don’t pass the verify will be forwarded to the FROM address of the --reply option. This allows you to set up a repository so that anyone who is authorized can push to it and have it automatically applied, but if a stranger pushes to it, the patch will be forwarded to you. Please (for your own sake!) be certain that the --reply FROM address is different from the one used to send patches to a pushable repository, since otherwise an unsigned patch will be forwarded to the repository in an infinite loop.

If you use ‘darcs apply --verify PUBRING --reply’ to create a pushable repo by applying patches automatically as they are received by email, you will also want to use the --dont-allow-conflicts option.

The --dont-allow-conflicts flag causes apply to fail when applying a patch would cause conflicts. This flag is recommended on repositories which will be pushed to or sent to.

--allow-conflicts will allow conflicts, but will keep the local and recorded versions in sync on the repo. This means the conflict will exist in both locations until it is resolved.

--mark-conflicts will add conflict markers to illustrate the the conflict.

You can use an external interactive merge tool to resolve conflicts with the flag --external-merge. For more details see subsection 6.1.

If you provide the --interactive or --gui flag, darcs will ask you for each change in the patch bundle whether or not you wish to apply that change. The opposite is the --all flag, which can be used to override an interactive or gui which might be set in your “defaults” file.

If you specify the --test option, apply will run the test (if a test exists) prior to applying the patch. If the test fails, the patch is not applied. In this case, if the --reply option was used, the results of the test are send in the reply email. You can also specify the --no-test option, which will override the --test option, and prevent the test from being run. This is helpful when setting up a pushable repository, to keep users from running code.

6.5 Seeing what you’ve done

6.5.1 darcs whatsnew

Usage: darcs whatsnew [OPTION]... [FILE or DIRECTORY]...

Options:

Display unrecorded changes in the working directory. whatsnew gives you a view of what changes you’ve made in your working directory that haven’t yet been recorded. The changes are displayed in darcs patch format. Darcs whatsnew will return a non-zero value if there are no changes, which can be useful if you just want to see in a script if anything has been modified. If you want to see some context around your changes, you can use the -u option, to get output similar to the unidiff format.

If you give one or more file or directory names as an argument to whatsnew, darcs whatsnew will output only changes to those files or to files in those directories.

6.5.2 darcs changes

Usage: darcs changes [OPTION]... [FILE or DIRECTORY]...

Options:

Changes gives a human-readable list of changes between versions suitable for use as a changelog.

When given one or more files or directories as an argument, changes lists only those patches which affect those files or the contents of those directories, or of course the directories themselves. This includes changes that happened to files before they were moved or renamed.

If changes is given a --from-patch, --from-match, or --from-tag option, it outputs only those changes since that tag or patch.

Without any options to limit the scope of the changes, history will displayed going back as far as possible.

When given the --context flag, darcs changes outputs sufficient information which will allow the current state of the repository to be recreated at a later date. This information should generally be piped to a file, and then can be used later in conjunction with darcs get --context to recreate the current version. Note that while the --context flag may be used in conjunction with --xml-output or --human-readable, in neither case will darcs get be able to read the output. On the other hand, sufficient information will be output for a knowledgeable human to recreate the current state of the repository.

6.6 More advanced commands

6.6.1 darcs tag

Usage: darcs tag [OPTION]... 

Options:

Tag is used to name a version of the tree. Tag differs from record in that it doesn’t record any new changes, and it always depends on all patches residing in the repository when it is tagged. This means that one can later reproduce this version of the repository by calling, for example:

Each tagged version has a version name. The version is also flagged with the person who tagged it (taken by default from the ‘DARCS_EMAIL’ or ‘EMAIL’ environment variable). The date is also included in the version information.

A tagged version automatically depends on all patches in the repo. This allows you to later reproduce precisely that version. The tag does this by depending on all patches in the repo, except for those which are depended upon by other tags already in the repo. In the common case of a sequential series of tags, this means that the tag depends on all patches since the last tag, plus that tag itself.

The --checkpoint option allows the tag be used later with the --partial flag to get or check.

A partial repository only contains patches from after the checkpoint. A partial repository works just like a normal repository, but any command that needs to look at the contents of a missing patch will complain and abort.

If you run tag with the --pipe option, you will be prompted for the tag name and date. This interface is intended for scripting darcs, in particular for writing repository conversion scripts. The prompts are intended mostly as useful guide (since scripts won’t need them), to help you understand the format in which to provide the input. Here’s an example of what the --pipe prompts looks like:

Using tag creates an entry in the repo history just like record. It will show up with darcs changes appearing in the format:

Because the word ’tagged’ is always prepended to the tag name, you can search for tag names by simply passing the output of darcs changes through grep:

The above example would display all the tag names in use in the repo.

6.6.2 darcs setpref

Usage: darcs setpref [OPTION]... <PREF> <VALUE>

Options:

Usage example:

Setpref allows you to set a preferences value in a way that will propagate to other repositories.

Valid preferences are: test predist boringfile binariesfile. If you just want to set the pref value in your repository only, you can just edit “_darcs/prefs/prefs”. Changes you make in that file will be preserved.

The “_darcs/prefs/prefs” holds the only preferences information that can propagate between repositories by pushes and pulls, and the only way this happens is when the setprefs command is used. Note that although prefs settings are included in patches, they are not fully version controlled. In particular, depending on the order in which a series of merges is perform, you may end up with a different final prefs configuration. In practice I don’t expect this to be a problem, as the prefs usually won’t be changed very often.

The following values are valid preferences options which can be configured using setpref:

• “test” -- the command to run as a test script.
• “predist” -- a command to run prior to tarring up a distribution tarball. Typically this would consist of autoconf and/or automake.
• “boringfile” -- the name of a file to read instead of the “boring” prefs file.
• “binariesfile” -- the name of a file to read instead of the “binaries” prefs file.

6.6.3 darcs check

Usage: darcs check [OPTION]... 

Options:

Check the repository for consistency. Check verifies that the patches stored in the repository, when successively applied to an empty tree, properly recreate the stored pristine tree.

If you have a checkpoint of the repository (as is the case if you got the repo originally using darcs get --partial), by default darcs check will only verify the contents since the most recent checkpoint. You can change this behavior using the --complete flag.

If you like, you can configure your repository to be able to run a test suite of some sort. You can do this by using “setpref” to set the “test” value to be a command to run. e.g.

Or, if you want to define a test specific to one copy of the repository, you could do this by editing the file _darcs/prefs/prefs.

Normally darcs deletes the directory in which the test was run afterwards. Sometimes (especially when the test fails) you’d prefer to be able to be able to examine the test directory after the test is run. You can do this by specifying the --leave-test-directory flag. Alas, there is no way to make darcs leave the test directory only if the test fails. The opposite of --leave-test-directory is --remove-test-directory, which could come in handy if you choose to make --leave-test-directory the default (see section 4.1).

If you just want to check the consistency of your repository without running the test, you can call darcs check with the --no-test option.

6.6.4 darcs optimize

Usage: darcs optimize [OPTION]... 

Options:

Optimize can help to improve the performance of your repository in a number of cases.

Optimize always writes out a fresh copy of the inventory that minimizes the amount of inventory that need be downloaded when people pull from the repo.

Specifically, it breaks up the inventory on the most recent tag. This speeds up most commands when run remotely, both because a smaller file needs to be transfered (only the most recent inventory). It also because it gives a guarantee that all the patches prior to a given tag are included in that tag, so less commutation and history traversal is needed. This latter issue can become very important in large repositories.

If you use the --checkpoint option optimize creates a checkpoint patch for a tag. You can specify the tag with the --tag option, or just let darcs choose the most recent tag. Note that optimize --checkpoint will fail when used on a “partial” repository. Also, the tag that is to be checkpointed must not be preceeded by any patches that are not included in that tag. If that is the case, no checkpointing is done.

The created checkpoint is used by the --partial flag to get and check. This allows for users to retrieve a working repository with limited history with a savings of disk space and bandwidth.

Some compression options are available, and are indepedent of the --checkpoint option.

By default the patches in the repository are compressed. These use less disk space, which translates into less bandwidth if repository is accessed remotely. Note that patches will always have the ”.gz” extension whether they are compressed or note.

You may want to uncompress the patches when you’ve got enough disk space but are running out of physical memory.

If you give the --compress option, optimize will compress all the patches in the repository. Similarly, if you give the --uncompress, optimize will decompress all the patches in the repository. --dont-compress means ”don’t compress, but don’t uncompress either”. It would be useful if one of the compression options was provided as a default and you wanted to override it.

The --relink option causes Darcs to relink files from a sibling. See Section 3.6.

6.7 Undoing, redoing and running in circles

6.7.1 darcs amend-record

Usage: darcs amend-record [OPTION]... [FILE or DIRECTORY]...

Options:

Amend-record is used to replace a patch with a newer version with additional changes.

If you provide one or more files or directories as additional arguments to amend-record, you will only be prompted to changes in those files or directories.

The old version of the patch is lost and the new patch will include both the old and the new changes. This is mostly the same as unrecording the old patch, fixing the changes and recording a new patch with the same name and description.

amend-record will modify the date of the recorded patch. WARNING: You should ONLY use amend-record on patches which only exist in a single repository!

If you configure darcs to run a test suite, darcs will run this test on the amended repo to make sure it is valid. Darcs first creates a pristine copy of the source tree (in a temporary directory), then it runs the test, using its return value to decide if the amended change is valid.

6.7.2 darcs rollback

Usage: darcs rollback [OPTION]... 

Options:

Rollback is used to undo the effects of a single patch without actually deleting that patch. Instead, it applies the inverse patch as a new patch. Unlike unpull and unrecord (which accomplish a similar goal) rollback is perfectly safe, since it leaves in the repository a record of the patch it is removing. If you decide you didn’t want to roll back a patch after all, you probably should use unrecord to undo the rollback, since like rollback, unrecord doesn’t affect the working directory.

6.7.3 darcs unrecord

Usage: darcs unrecord [OPTION]... 

Options:

Unrecord is used to undo a single recorded patch. It will prompt you for which patch to unrecord, and then will undo that patch. Unrecord doesn’t affect your working copy of the tree at all.

Unrecord can be thought of as undo-record. If a record is followed by an unrecord, everything looks like before the record; all the previously unrecorded changes are back, and can be recorded again in a new patch. The unrecorded patch however is actually removed from your repository, so there is no way to record it again to get it back.⁴.

If you want to remove the change from the working copy too (where they otherwise will show up as unrecorded changes again), you’ll also need to darcs revert. To do unrecord and revert in one go, you can use darcs unpull.

If you don’t revert after unrecording, then the changes made by the unrecorded patches are left in your working tree. If these patches are actually from another repository, interaction (either pushes or pulls) with that repository may be massively slowed down, as darcs tries to cope with the fact that you appear to have made a large number of changes that conflict with those present on the other repository. So if you really want to undo the result of a pull operation, use unpull! Unrecord is primarily intended for when you record a patch, realize it needs just one more change, but would rather not have a separate patch for just that one change.

6.7.4 darcs unpull

Usage: darcs unpull [OPTION]... 

Options:

Unpull is used to undo a single patch that has been pulled from another repository. It will prompt you for which patch to unpull, and then will undo that patch. Beware that unpull undoes the patch both from the repo records AND from the current working directory, and does NOT check that the patch originated with a pull. In other words, you could lose precious code by unpulling!

Like unrecord, unpull does not just apply an inverse patch to the repository, it actually deletes the patch from the repository. This makes unpull a particularly dangerous command, as it not only deletes the patch from the repo, but also removes the changes from the working directory. It is equivalent to an unrecord followed by a revert, except that revert can be unreverted.

Contrary to what its name suggests, there is nothing in unpull that requires that the “unpulled” patch originate from a different repository. The name was chosen simply to suggest a situation in which it is “safe” to used unpull. If the patch was originally from another repo, then unpulling is safe, because you can always pull the patch again if you decide you want it after all. If you unpull a locally recorded patch, all record of that change is lost, which is what makes this a “dangerous” command, and thus deserving of a obscure name which is more suggestive of when it is safe to use than precisely what it does.

Each of these options is used to select a single patch to unpull. In the case of --tag, what you are unpulling is the tag itself, not any other patches.

6.7.5 darcs revert

Usage: darcs revert [OPTION]... [FILE or DIRECTORY]...

Options:

Revert is used to undo changes made to the local tree which have not yet been recorded. You will be prompted for which changes you wish to undo. The actions of a revert may be reversed using the unrevert command (see subsection 6.7.6). However, if you’ve made changes since the revert your mileage may vary, so please be careful.

You can give revert optional arguments indicating files or directories. If you do so it will only prompt you to revert changes in those files or in files in those directories.

6.7.6 darcs unrevert

Usage: darcs unrevert [OPTION]... 

Options:

Unrevert is used to undo the results of a revert command.

While this is only guaranteed to work properly if you haven’t made any changes since the revert was performed, it makes a best effort to merge the unreversion with any changes you have since made. In fact, unrevert should even work if you’ve recorded changes since reverting.

6.8 Advanced examination of the repository

6.8.1 darcs diff

Usage: darcs diff [OPTION]... [FILE or DIRECTORY]...

Options:

Diff can be used to create a diff between two versions which are in your repository. Specifying just -from-patch will get you a diff against the version in your working directory. If you give diff no version arguments, it gives you the same information as whatsnew except that the patch is formatted as the output of a diff command

Diff calls an external “diff” command to do the actual work, and passes any unrecognized flags to this diff command. Thus you can call

to get a diff in the unified format. Actually, thanks to the wonders of getopt you need the “--” shown above before any arguments to diff. You can also specify additional arguments to diff using the --diff-opts flag. The above command would look like this:

This may not seem like an improvement, but it really pays off when you want to always give diff the same options. You can do this by adding

to your _darcs/prefs/defaults file.

If you want to view only the differences to one or more files, you can do so with a command such as

FIXME: I should allow the user to specify the external diff command. Currently it is hardwired to ”diff”.

6.8.2 darcs annotate

Usage: darcs annotate [OPTION]... [FILE or DIRECTORY]...

Options:

Display which patch last modified something, or display patch contents Annotate displays which patches created or last modified a directory file or line. It can also display the contents of a particular patch in darcs format.

When called with just a patch name, annotate outputs the patch in darcs format, which is the same as --human-readable.

--xml-output is the alternative to --human-readable.

--summary can be used with either the --xml-output or the --human-readable options to alter the results. It is documented fully in the ’common options’ portion of the manual.

Giving the --unified flag implies --human-readable, and causes the output to remain in a darcs-specific format that is similar to that produced by diff --unified.

If a directory name is given, annotate will output details of the last modifying patch for each file in the directory and the directory itself. The details look like this:

If a patch name and a directory are given, these details are given for the time after that patch was applied will be output. If a directory and a tag name are given, the details of the patches involved in the specified tagged version will be output.

If a file name is given, the last modifying patch details of that file will be output, along with markup indicating patch details when each line was last (and perhaps next) modified.

The --creator-hash option should only be used in combination with a file or directory to be annotated. In this case, the name of that file or directory is interpereted to be its name at the time it was created, and the hash given along with --creator-hash indicates the patch that created the file or directory. This allows you to (relatively) easily examine a file even if it has been renamed multiple times.

6.9 Rarely needed and obscure commands

6.9.1 darcs resolve

Usage: darcs resolve [OPTION]... 

Options:

Resolve is used to mark and resolve any conflicts that may exist in a repository. Note that this trashes any unrecorded changes in the working directory.

6.9.2 darcs dist

Usage: darcs dist [OPTION]... 

Options:

Create a distribution tarball.

Dist is a handy tool for implementing a “make dist” target in your makefile. It creates a tarball of the recorded edition of your tree. Basically, you will typically use it in a makefile rule such as

darcs dist then simply creates a clean copy of the source tree, which it then tars and gzips. If you use programs such as autoconf or automake, you really should run them on the clean tree before tarring it up and distributing it. You can do this using the pref value “predist”, which is a shell command that is run prior to tarring up the distribution:

6.9.3 darcs trackdown

Usage: darcs trackdown [OPTION]... [INITIALIZATION] [COMMAND]

Options:

Trackdown tries to find the most recent version in the repository which passes a test. Given no arguments, it uses the default repository test. Given one argument, it treats it as a test command. Given two arguments, the first is an initialization command with is run only once, and the second is the test command.

Trackdown is helpful for locating when something was broken. It creates a temporary directory with the latest repo content in it and cd to it. First, and only once, it runs the initialization command if any, for example

Then it runs the test command, for example

While the test command exits with an error return code, darcs “unapplies” one patch from the version controlled files to retrieve an earlier version, and repeats the test command. If the test command finally succeeds, the name of the hunted down patch is found in the output before the last test run.

FIXME: It is still rather primitive. Currently it just goes back over the history in reverse order trying each version. I’d like for it to explore different patch combinations, to try to find the minimum number of patches that you would need to unpull in order to make the test succeed.

FIXME: I also would like to add an interface by which you can tell it which patches it should consider not including. Without such a feature, the following command:

would result in compiling every version in the repository-which is a rather tedious prospect.

Example usage

If you want to find the last version of darcs that had a FIXME note in the file Record.lhs, you could run

To find the latest version that compiles, you can run

Trackdown can also be used to see how other features of the code changed with time. For example

would let you see how long ‘darcs check’ takes to run on each previous version of darcs that will actually compile. The “&& false” ensures that trackdown keeps going.

6.9.4 darcs repair

Usage: darcs repair [OPTION]... 

Options:

Repair attempts to fix corruption that may have entered your repository.

Repair currently will only repair damage to the pristine tree. Fortunately this is just the sort of corruption that is most likely to happen.

Appendix A
Theory of patches