« Previous - Version 8/37 (diff) - Next » - Current version
Dan Smith, 01/01/2013 09:23 am


CHIRP Development Process

Mercurial Configuration

Make sure that your mercurial tool is configured properly for CHIRP. This means having the correct username and email address specified, as well as the MQ extension enabled (for most cases). You can do this in your global mercurial configuration file, or in the one in the repository you're working on, which is .hg/config. You may also want to ensure that it has the patchbomb configuration enabled, which allows easy emailing out of mercurial itself. You probably want the following lines in your config file:

[ui]
username = Joe Bob <joebob@gmail.com>
[extensions]
hgext.mq=
hgext.patchbomb=

[email]
from = Joe Bob <joebob@gmail.com>
method = smtp

[smtp]
host = smtp.gmail.com

Bug Tracking

All changes should have a bug created on the tracker before submission. The server hosting the repository will not allow changesets to be pushed that do not contain a bug number (see below). It is perfectly reasonable to create a bug, assign it to yourself, and then close it before sending the patch.

Submitting a patch

Changes to CHIRP are welcome, but they should be in the correct format, and sent as a patch to the mailing list. The correct way to do this is to clone the upstream repository, make your changes there, and then soft-commit them as MQ patches to the tree. The following assumes you have cloned the repository and are in the resulting directory.

Making a change

Edit one of the files to make a change. For this example, I'll use chirp/ic2820.py. Assuming I have made a change, the following commands help me see what has been done:

% hg status -mar
M chirp/ic2820.py
% hg diff
diff -r a132c837fd25 chirp/ic2820.py
--- a/chirp/ic2820.py   Mon Dec 24 08:17:19 2012 -0800
+++ b/chirp/ic2820.py   Mon Dec 24 08:56:29 2012 -0800
@@ -16,6 +16,8 @@
 from chirp import chirp_common, icf, util, directory
 from chirp import bitwise

+# Just added a comment
+
 MEM_FORMAT = """ 
 struct {
   u32  freq;

The first command shows me that chirp/ic2820.py has been modified, and the second shows me the actual changes that have been made.

Soft-committing a Change

You can commit a change directly to your tree, but it becomes a little more complicated to make changes to it if necessary, and it creates a fork when the change is actually accepted upstream. An easy way to manage all of this is to soft-commit your changes as MQ patches. Assuming you have made the change above, the following example shows the process for committing that into a patch:

% hg qnew -ef add_comment # Here I will be prompted to enter a commit message
% hg qapplied             # This shows that the patch is now applied
add_comment

This example takes the changes I made above, and commits them into a new patch called add_comment. I can now look at the patch in its entirety, as well as add or remove it from my local tree:

% hg export tip           # This will show me the whole patch, with the commit message
% hg qpop                 # Remove it from the tree
% hg qapplied             # This shows that no patches are applied
% hg qunapplied           # This shows that our patch is not applied
add_comment
% hg qpush                # This adds the patch back to the tree
% hg qapplied             # This shows that our patch is applied
add_comment
% hg qpop                 # This removes it again
% hg qdel add_comment     # This deletes it permanently

Testing

CHIRP has a modest test suite used to validate driver behavior in the tests/ directory. Before submitting a patch, please ensure that all the tests run and pass (or at least pass as well as before you made the change). To run the whole set, do this:

% cd tests
% ./run_tests

Note that on Windows, you probably want to run the script like this:

C:\Users\Foo\chirp.hg> python run_tests

To run just a single driver's tests:

% ./run_tests -d Icom_IC-2820H

To run just a specific test:

% ./run_tests -t Edges

If you are adding a new driver, you will need to add an image to the tests/images/ directory which is correctly named for your model. These do not communicate well in patch form, so just send a sample image to the development mailing list to accompany your patch submission.

Note: Please make sure that all the tests run, not just the one that affects your driver. Several of the drivers play off each other and sometimes changes to one will break another.

Sending a change

There are two ways to do this. First, you can export the patch to a text file and email it to the list with your normal mailer. This is how:

% hg export tip > add_comment.patch

You can also configure the tool to email it directly, in which case you need only do:

% hg email tip

You will be prompted for the destination address.

Patch Guidelines

The Commit Message

The commit message should have a first line that stands on its own and describes the patch briefly. If it pertains to a specific driver, put that driver's short name in brackets at the beginning. For example:

[uv5r] Add support for firmware >= 291

After the first line, more descriptive text may be added (and is appreciated) about what and why the change is being made. At the end, you must include a bug number in the format #XXX. This lets the system correlate changes to bugs, which helps during release time.

Scope

Guidelines:

  • Patches should be small and concise. Try to keep a single standing change to a single patch.
  • Don't fix several bugs in a single patch, unless there is a technical reason to do so.
  • Don't fix, cleanup, or change random whitespace in the patch unless that is the sole purpose of the patch.