PATCHES.txt

   1
   2
   3
   4 PATCHES(1)            LilyPond documentation           PATCHES(1)
   5
   6
   7 NAME
   8        PATCHES - track and distribute your code changes
   9
  10 DESCRIPTION
  11        This page documents how to distribute your changes to GNU
  12        LilyPond
  13
  14 ABSTRACT
  15        Distributing a change normally goes like this:
  16
  17        o    make your fix/add your code
  18
  19        o    Add changes to NEWS, and add yourself to
  20             Documentation/AUTHORS.pod
  21
  22        o    generate a patch,
  23
  24        o    e-mail your patch to one of the mailing lists gnu-
  25             music-discuss@gnu.org or bug-gnu-music@gnu.org
  26
  27 GENERATING A PATCH
  28        In VERSION, set TOPLEVEL_MY_PATCH_LEVEL:
  29
  30            VERSION:
  31                ...
  32                TOPLEVEL_MY_PATCH_LEVEL = jcn1
  33
  34        In NEWS, enter a summary of changes:
  35
  36            NEWS:
  37                pl 0.1.48.jcn1
  38                        - added PATCHES.pod
  39
  40        Then, from the top of Lily's source tree, type
  41
  42            make-patch
  43
  44        which leaves your patch as ./patch-0.1.48.jcn1.
  45
  46        If you didn't configure Lily using --srcdir, you can do:
  47
  48            release
  49
  50            tar-ball: ../patches/patch-0.1.48.jcn1.gz
  51            patch: ../patches/patch-0.1.48.jcn1.gz
  52            updeet: ../test/updeet
  53
  54
  55 PREREQUISITES
  56        For creating a patch you need
  57
  58        o    All items mentioned in INSTALL.  You're not going to
  59             send a patch that you haven't even built, right?
  60
  61
  62
  63
  64 12/May/98                LilyPond 0.1.65                        1
  65
  66
  67
  68
  69
  70 PATCHES(1)            LilyPond documentation           PATCHES(1)
  71
  72
  73        o    GNU Diff
  74
  75        o    Python (version 1.4 or newer).  You can of course
  76             make a patch by hand, which would go something like:
  77
  78                 make distclean
  79                 cd ..
  80                 diff -urN lilypond-0.1.48 lilypond-0.1.48.jcn1 > patch-0.1.48.jcn1
  81
  82             but there are handy python scripts available.  If
  83             you're doing development, you'll need Python for
  84             other LilyPond scripts anyway.
  85
  86        o    The Lily directory structure, which looks like:
  87
  88                 lilypond-0.1.48/
  89                 patches/
  90                 releases/
  91                 test/
  92
  93
  94        If you're following LilyPond development regularly, you
  95        probably want to download just the patch for each
  96        subsequent release.  After downloading the patch (into the
  97        patches directory, of course), simply apply it:
  98
  99            gzip -dc ../patches/patch-0.1.49.gz | patch -p1 -E
 100
 101        and don't forget to make automatically generated files:
 102
 103            autoconf 1)
 104            configure
 105
 106
 107 SYNCHRONISE
 108        If you're not very quick with sending your patch, there's
 109        a good chance that an new release of LilyPond comes
 110        available.  In such a case (and sometimes for other unkown
 111        reasons :-), the maintainer will probably ask you to make
 112        a new patch against the latest release.  Your best bet is
 113        to download the latest release, and apply your patch
 114        against this new source tree:
 115
 116            cd lilypond-0.1.49
 117            gzip -dc ../patches/patch-0.1.48.jcn1.gz | patch -p1 -E
 118            autoconf 1)
 119            configure
 120
 121        Then, make a patch as shown above.
 122
 123        1) patches don't include automatically generated files,
 124        i.e. configure
 125           and files generated by configure.
 126
 127
 128
 129
 130 12/May/98                LilyPond 0.1.65                        2
 131
 132
 133
 134
 135
 136 PATCHES(1)            LilyPond documentation           PATCHES(1)
 137
 138
 139 MAINTAINER
 140        Han-Wen Nienhuys <hanwen@cs.uu.nl>
 141
 142        Just keep on sending those patches!
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196 12/May/98                LilyPond 0.1.65                        3
 197
 198