Difference between revisions of "Repository"

Revision as of 23:29, 14 June 2008

M5 uses the Mercurial (a.k.a. hg) revision control system. The full M5 Mercurial repository is directly accessible at http://repo.m5sim.org. This website provides browser access to history and changesets and the ability to "clone" (create your own copy of) the repository on your local machine.

We host two M5 source repositories:

• m5-stable --- The (relatively) stable repository. The head of this repository is the latest version that has passed a full set of regression tests. This is the recommended repository for most users. This repository is updated automatically from the development repository when the full set of regressions runs and completes successfully. Currently, the full regression suite is run weekly, so this repository will be updated roughly that often.
• m5 --- The development repository. Code changes are always committed to this repository first. This code should work, because developers are supposed to run a limited set of regression tests before committing to this repository. However, this code has generally not been tested against the full regression suite, and developers occasionally mess up and commit things that don't work as well as they expected.

What is it?

Mercurial (hg) is a distributed version control system. Every copy of a mercurial repository is complete and fully functional. Any operation (examining history, committing changes, etc) can be done without communicating with a central repository. (In fact, from mercurial's point of view, there is no central repository; the m5sim.org repositories are "central" only by user convention.) Instead of having to manually diff/patch your changes when a new version is released simply executing a command will "pull" all changes in the m5sim.org repository into your local repository launching a merge tool whenever necessary. Additionally, patches can be sent to us for inclusion in the m5sim.org repository with a single command.

Where can I get more information about it?

The main Mercurial website is here. Other good sources of information about Mercurial is the hg book and the HG Cheat Sheets. We promise that it is worth taking 30 minutes to read some of the documentation to get you started. You may even decide that you really like hg and want to use it in your own projects. We do!

How do I use it?

The first thing you need to do is install hg (from either package for your OS/distribution or from source). Debian and Ubuntu have packages named mercurial that you can install. MacPorts also has a package. The next thing you should do is setup a .hgrc. An example .hgrc is provided below. It enables various extensions that come with Mercurial and allows you to mail patches to the M5 mailing list if you so choose.

[ui]
# Set the username you will commit code with
username=Your Name <your@email.address> 
ssh = ssh -C

# Always use git diffs since they contain permission changes and rename info
[defaults] 
qrefresh = --git
email = --git
diff = --git

[extensions]
# These are various extensions we find useful

# Mercurial Queues -- allows managing of changes as a series of patches
hgext.mq =

# PatchBomb -- send a series of changesets as e-mailed patches
hgext.patchbomb = 
 
# External Diff tool (e.g. kdiff3, meld, vimdiff, etc)
hgext.extdiff =

# Fetch allows for a pull/update operation to be done with one command and automatically commits a merge changeset
hgext.fetch = 

# Path to the style file for the M5 repository 
# This file enforces our coding style requirements
style = /path/to/your/m5/util/style.py

[email]
method = smtp
from = Your Name <your@email.address>

[smtp]
host = your.smtp.server.here

Basic Commands

Here are some basic commands for Mercurial, however this is not exhaustive and you should read the Mercurial documentation.

Cloning creates a complete and fully functional copy of a repository. To get started you should execute:

hg clone http://repo.m5sim.org/m5-stable

Once you've got a clone of the repository, here are a few basic commands you can use:

• hg status shows what files have been modified in your repository
• hg diff shows a diff of the modified files
• hg fetch fetches any new updates from the repository you cloned (in this case, m5-stable), and if necessary merges them with any changes you have made since the last update. Note that fetch is a convenient extension that combines several other primitive hg operations that you can also do separately: hg pull, hg update, and if needed hg merge and hg commit. See the mercurial documentation for more details.

Making Your Own Changes

We highly recommend that you use Mercurial Queues (MQ) to make any changes to M5 that you personally need. There is a chapter on using MQ in the HG-Book you should take the time to read the chapter in the book; it will make your life much easier.

The basic idea of MQ is to provide management commands to create and apply patches to an upstream source tree. When the underlying source tree is updated (see above), you can remove your patches, get the new changes and reapply your patches very quickly. The patches themselves can be an complete mercurial repository that is revision controlled.

E-mailing Patches

The patchbomb extension is a great way to share patches with other users. It adds the hg email command which allows you to send a set of changesets (or mq patches) to the m5 developer's mailing list!

To e-mail us patches you'll need to add the following to m5/.hg/hgrc (or create it if it doesn't exist).

[email]
to = m5-dev@m5sim.org

Then to e-mail a particular changeset simply execute: hg email [REV]