HACKING

   1 Coding Style
   2 ------------
   3
   4 Use hard tabs. Tabs are _always_ 8 characters wide.
   5
   6 Don't use typedef if not really needed.  So instead of
   7
   8         typedef struct {
   9                 ...
  10         } foo, *foop;
  11
  12 write this
  13
  14         struct foo {
  15                 ...
  16         };
  17
  18 Keep style consistent with rest of the code.
  19
  20
  21 Using GIT
  22 ---------
  23
  24 Clone my repo
  25
  26         git clone git://onion.dynserv.net/git/cmus.git cmus
  27
  28 Run following commands in the cmus directory
  29
  30 Keep it up to date
  31
  32         git pull
  33
  34 View commit log
  35
  36         git log
  37
  38 What changed?
  39
  40         # commit log only for pl.c
  41         git whatchanged pl.c
  42
  43         # show commit log and diff output from 1.6.7 to HEAD
  44         git whatchanged -p 1.6.7..
  45
  46 Write an AAC plugin ;)
  47
  48         # add your personal information to config
  49         # needed if you want to commit changes
  50         edit .git/config
  51
  52         ------------- 8< -----------------------------
  53         [user]
  54                 name = "Random Developer"
  55                 email = "random@site.com"
  56         ------------- 8< -----------------------------
  57
  58         # it's recommended to have separate branch for your own
  59         # modifications
  60
  61         # create a new branch (aac) and switch to it
  62         git checkout -b aac
  63
  64         # show current branch
  65         git branch
  66
  67         # code code code
  68         # this is the easy part. do it just for fun [1]
  69         edit aac.c
  70
  71         # what files you have changed?
  72         git status
  73
  74         # show what you have changed
  75         git diff
  76
  77         # add files, or tell git that you have changed some files
  78         # this marks files for commit
  79         git-update-index aac.c aac.h
  80
  81         # when everything is ok, commit
  82         git commit
  83
  84         # you can give git-commit the files you want to commit
  85         git commit foo.c
  86
  87         # all
  88         git commit -a
  89
  90         # update master branch
  91         # 1) change branch
  92         git checkout master
  93         # 2) pull changes
  94         git pull
  95
  96         # change back to aac branch
  97         git checkout aac
  98
  99         # merge with master
 100         git pull . master
 101
 102         # create a patch from top most commit
 103         # creates 0001-name-of-the-commit.txt
 104         git format-patch HEAD^..
 105
 106 More: http://www.kernel.org/pub/software/scm/git/docs/everyday.html
 107
 108
 109 Misc
 110 ----
 111
 112 Configure cmus with extra compiler warnings enabled:
 113
 114         ./configure --dev
 115
 116 This also sets --prefix=$HOME and --debug=2. Of course you can override
 117 them when needed.
 118
 119 Fix all warnings and test the code.
 120
 121 Watch /tmp/cmus-debug
 122
 123 If you have sparse installed:
 124
 125         make C=2
 126
 127 Verbose build:
 128
 129         make V=2
 130
 131
 132 Patches
 133 -------
 134
 135 Use git-format-patch to generate patches from commits. Alternatively you
 136 can use "diff -up" if you don't want to use git.
 137
 138 Send patches to me: Timo Hirvonen <tihirvon@gmail.com>
 139
 140 ---
 141
 142 [1] meaning of 'fun' inverted
 143
 144 vim: tw=72