PATCHES

   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    generate a patch,
  20
  21        o    e-mail your patch to one of the mailing lists gnu-
  22             music-discuss@gnu.org or bug-gnu-music@gnu.org (or if
  23             you're a bit shy, to the maintainer).
  24
  25 GENERATING A PATCH
  26        In VERSION, set TOPLEVEL_MY_PATCH_LEVEL:
  27
  28            VERSION:
  29                ...
  30                TOPLEVEL_MY_PATCH_LEVEL = jcn1
  31
  32        In NEWS, enter a summary of changes:
  33
  34            NEWS:
  35                pl 0.1.48.jcn1
  36                        - added PATCHES.pod
  37
  38        Then, type something like
  39
  40            make-dist
  41            mv out/lilypond-0.1.48.jcn1.tar.gz ../releases
  42            make-patch
  43
  44        which leaves your patch as ./patch-0.1.48.jcn1.
  45
  46        or even simpler:
  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 13/Mar/98                LilyPond 0.1.48                        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 not very quick with sending your patch, there's
  95        a good chance that an new release of LilyPond comes
  96        available.  In such a case (and sometimes for other unkown
  97        reasons :-), the maintainer will probably ask you to make
  98        a new patch against the latest release.  Your best bet is
  99        to download the latest release, and apply your patch
 100        against this new source tree:
 101
 102            cd lilypond-0.1.49
 103            zpatch -p0 -E < ../patches/patch-0.1.48.jcn1.gz
 104
 105        Then, make a patch as shown above.
 106
 107 MAINTAINER
 108        Han-Wen Nienhuys <hanwen@cs.ruu.nl>
 109
 110        Just keep on sending those patches!
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130 13/Mar/98                LilyPond 0.1.48                        2
 131
 132