HACKING

   1 Submitting patches to the OpenOCD mailing list:
   2
   3 By the time you have read this, one supposes that
   4 you have figured out how to clone the OpenOCD git
   5 repository.
   6
   7 Below is a basic workflow and specific instructions
   8 to get you going with git and patches.
   9
  10 0. Clone the git repository, rather than just
  11 download the source.
  12
  13 git clone git://openocd.git.sourceforge.net/gitroot/openocd/openocd
  14
  15 or if you have problems with the "git:" protocol, use
  16 the slower http protocol:
  17
  18 git clone http://repo.or.cz/r/openocd.git
  19
  20 1. Set up git with your name and email:
  21
  22 git config --global user.name "John Smith"
  23 git config --global user.email "john@smith.org"
  24
  25 2. Work on your patches. Split the work into
  26 multiple small patches that can be reviewed and
  27 applied seperately and safely to the OpenOCD
  28 repository.
  29
  30 while(!done) {
  31   work - edit files using your favorite editor.
  32   run "git commit -a" to commit all changes.
  33 }
  34
  35 TIP! use "git add ." before commit to add new files.
  36
  37 3. Next you need to make sure that your patches
  38 are on top of the latest stuff on the server and
  39 that there are no conflicts.
  40
  41 git pull --rebase
  42
  43 4. Generate the patch files. This will generate
  44 patches for all commits that are on top of
  45 the latest stuff on the server:
  46
  47 git format-patch origin/master
  48
  49 5. Email the patches to openocd-development@lists.berlios.de