wiki:pm-svn-externals

Handling Subversion Externals

Externals allow subversion to download additional packages from other subversion repositories. For example, the COIN-OR project Clp requires the COIN-OR project CoinUtils to be compiled. Therefore, the Clp repository has externals defined so that CoinUtils is automatically downloaded when a user checks out Clp.

Basics

Externals are defined as a subversion property associated with a directory in a subversion repository (with the name svn:externals). If someone checks out such a directory, the corresponding externals (defined using URLs) are also checked out, into subdirectories of that directory. The names of those subdirectories, as well as the URL, are defined in the svn:externals property. It is possible to specify a specific revision number for an external. This helps us in COIN-OR to ensure that people get a compatible version of a dependency --- the latest development version in the trunk of a dependency might not work with the code of the package one is trying to download and compile, if the development of the dependency has introduced incompatible changes. Also, we can ensure in this way that point releases will always obtain the same version of their dependencies.

Externals are checked out recursively, i.e., if there is an svn:externals property defined in a directory downloaded for an external, it is also downloaded. One can suppress the checkout (or the action of other svn commands) of externals by specifying the --ignore-externals flag.

Externals in COIN-OR

In COIN-OR, we use externals mainly to ensure that COIN-OR packages which require other COIN-OR packages obtain those packages automatically.

Our policy for managing externals in COIN-OR is that we put a file called Dependencies into a directory. In the Dependencies file, for each required COIN-OR package, a stable branch should be specified. It is encouraged, that both development versions (e.g., trunk) and stable branches of a project list either stable branches or point releases in the Dependencies file. For point releases, it is mandatory to do so. For example, the Dependencies file in the base directory for the 1.13.3 point release of the Clp package looks like this:

BuildTools  https://projects.coin-or.org/svn/BuildTools/stable/0.6
Data/Sample https://projects.coin-or.org/svn/Data/Sample/stable/1.1/
CoinUtils   https://projects.coin-or.org/svn/CoinUtils/stable/2.7/CoinUtils
Osi         https://projects.coin-or.org/svn/Osi/stable/0.104/Osi

The first entry in each row specifies the directory (relative to the current directory) into which the external is to be placed (this can specify several levels of subdirectories). After this, one can optionally specify the revision number of the dependency code that is to be obtained using the -rN flag, where N is the revision number. The last column is the URL that specifies the location of the dependency in a repository.

In the svn:externals property, however, for each required COIN-OR package, a point release is specified. For example, the svn:externals property of the 1.13.2 point release of the Clp package looks like this:

BuildTools  https://projects.coin-or.org/svn/BuildTools/releases/0.6.3/
Data/Sample https://projects.coin-or.org/svn/Data/Sample/releases/1.1.0/
CoinUtils   https://projects.coin-or.org/svn/CoinUtils/releases/2.7.1/CoinUtils
Osi         https://projects.coin-or.org/svn/Osi/releases/0.104.2/Osi

Important Considerations For Externals

It is mandatory that the externals for a point release in a releases/ subdirectory specify dependencies that do not change at any later point in time, so that the original point release can always be recreated. We have no mechanism in place that enforces this, so we rely on the project manager's discipline to adhere to this convention.

In the above example we see that all externals have been set to things that are not going to change at some later point in time: By convention, subdirectories in the releases/ directory for each COIN-OR project are tags, i.e., they should never be changed once they have been created. Pointing to specific releases/ subdirectories is recommended. If, for some reason, the required code is not available in a releases/ subdirectory, the externals definition must specify a particular subversion repository revision number using the -r flag.

Thus, modifications to externals are only allowed for development versions and stable branches. Note, however, that modifications to stable branches should consist of bugfixes only. Therefore, there should be no need to change the Dependencies file in a stable branch. Updates to newer releases of a dependency are reflected by changes in the svn:externals property, which can easily be achieved by executing the set_externals script - see next point.

Manipulating Externals

To see the value of a property (such as svn:externals) one uses the svn propget command. For example, to see the current value set for the externals in the Clp base directory, move into the Clp base directory and issue the command

svn propget svn:externals .

Changing external dependencies is a three-step process:

  1. Edit the Dependencies file to modify, add, or remove lines specifying external dependencies.
  2. Execute the script set_externals from the BuildTools directory with the name of the Dependencies file as option:
    BuildTools/set_externals Dependencies
    
    The script converts the specification of stable branches in the Dependencies file to latest point releases and sets the svn:externals property to this set of releases by executing the svn propset command.
  3. Once the svn:externals property has been updated, the changes will be applied at the next svn update command: changed dependencies will be updated, new dependencies will be downloaded, and dependencies removed from the svn:externals property will be removed from subversion's records. (However, the directories must be removed by hand, after you've run svn update.) Heads Up: Keep in mind that subversion knows nothing of the COIN-OR convention for using a Dependencies file. Nothing will change until you run a subversion command (e.g., svn commit) to change the svn:externals property.

If you want to change the value of the svn:externals property manually, you can use the svn propset command. E.g., for testing, it may be useful to use the stable branches of other projects as specified in the Dependencies file in the externals. This is achieved by executing the command

svn propset svn:externals -F Dependencies .

The -F flag tells svn to take the content of a file (in this case, Dependencies) as the value of the property to be set. That final `.' is important! The svn propset command requires that you explicitly specify the directory where the property change is to be applied.

Finally, if you decide to completely eliminate externals in a directory, you should delete the Dependencies file, and delete the svn:externals property with

svn propdel svn:externals .

Note: If you have configured your local copy with the --enable-maintainer-mode and have svn available on your system, the Makefiles will automatically execute the set_externals script for you when you change the Dependencies file. However, you will need to run the svn update command by hand.

More information about externals can be obtained in the Externals Definitions chapter of the subversion book.

Preparing Externals For A Point Release

(There are two scripts in BuildTools that automate this process. Read Creating New Point Release first.)

Typically, a stable version of a COIN-OR project that depends on other COIN-OR projects will specify a particular point release version (subdirectory) in the releases/ directory of each dependency. By convention, the compilation should not break when these versions are updated to new point releases of the same stable branch; a project manager should ensure compatibility of the project's code with the externals selected for use in a particular stable version.

If you now want to create a new point release from the latest version in your stable branch, we suggest you follow these steps:

  1. Get a local copy of your stable branch (you probably have it already).
  2. Execute the set_externals script,
    BuildTools/set_externals Dependencies
    
  3. Update the local copies in your working copy by typing svn update. (Note: If you have local changes in your checked-out externals, you should first arrange with the project manager for the dependency to have your changes committed into the dependency's repository. It is not a good idea in any case to have local modifications in your working copy of the stable branch, since you might forget to commit them back, and then a user might download a non-working dependency.)
  4. Make sure your code now still works fine:
    1. Clean everything (make clean).
    2. Rebuild the autotools files (./BuildToolds/run_autotools).
    3. Make sure (svn status) that the autotools rebuild did not change any files in the externals subdirectories. If the rebuild changed, e.g., a configure file, it means that the dependency does not use the same version of BuildTools that you are using. This should be reconciled first.
    4. Rerun configure.
    5. Compile and install the code (make install).
    6. Run your tests (make tests) and do whatever you do to convince yourself that your project's code works correctly.
  5. If that works fine, commit what is now in your local copy back into the stable branch of your project (svn commit).
  6. To confirm portability and act as a sanity test, you might want to check that the code now in your stable branch compiles and runs fine on a different machine (svn update and make tests on the other machine).
  7. Create a copy of the current version of your stable branch as a new point release, as described here.
Last modified 9 years ago Last modified on Mar 21, 2011 11:47:35 AM