]> git.donarmstrong.com Git - lilypond.git/commitdiff
lilypond-0.1.49
authorfred <fred>
Sun, 24 Mar 2002 20:06:58 +0000 (20:06 +0000)
committerfred <fred>
Sun, 24 Mar 2002 20:06:58 +0000 (20:06 +0000)
Documentation/PATCHES.pod [new file with mode: 0644]
Documentation/Rules.make
Documentation/faq.pod

diff --git a/Documentation/PATCHES.pod b/Documentation/PATCHES.pod
new file mode 100644 (file)
index 0000000..e98860d
--- /dev/null
@@ -0,0 +1,234 @@
+=head1 NAME
+
+PATCHES - track and distribute your code changes
+
+=head1 DESCRIPTION
+
+This page documents how to distribute your changes to GNU LilyPond
+
+=head1 ABSTRACT
+
+Distributing a change normally goes like this:
+
+=over 5
+
+=item *
+
+make your fix/add your code 
+
+=item *
+
+generate a patch, 
+
+=item *
+
+e-mail your patch to one of the mailing lists
+gnu-music-discuss@gnu.org or bug-gnu-music@gnu.org
+(or if you're a bit shy, to the maintainer).
+
+=back
+
+=head1 GENERATING A PATCH
+
+In F<VERSION>, set TOPLEVEL_MY_PATCH_LEVEL:
+
+    VERSION:
+       ...
+       TOPLEVEL_MY_PATCH_LEVEL = jcn1
+
+In F<NEWS>, enter a summary of changes:
+
+    NEWS:
+       pl 0.1.48.jcn1
+               - added PATCHES.pod
+
+Then, type something like
+
+    make dist
+    mv out/lilypond-0.1.48.jcn1.tar.gz ../releases
+    make-patch
+
+which leaves your patch as F<./patch-0.1.48.jcn1>.
+
+or even simpler:
+
+    release
+
+    tar-ball: ../patches/patch-0.1.48.jcn1.gz
+    patch: ../patches/patch-0.1.48.jcn1.gz
+    updeet: ../test/updeet
+
+=head1 PREREQUISITES
+
+For creating a patch you need
+
+=over 5
+
+=item *
+
+All items mentioned in F<INSTALL>.  You're not going to send a patch
+that you haven't even built, right?
+
+=item *
+
+GNU Diff
+
+=item *
+
+Python (version 1.4 or newer).  
+You can of course make a patch by hand, which would go something like:
+
+    make distclean
+    cd ..
+    diff -urN lilypond-0.1.48 lilypond-0.1.48.jcn1 > patch-0.1.48.jcn1
+
+but there are handy python scripts available.  If you're doing development,
+you'll need Python for other LilyPond scripts anyway.
+
+=item *
+
+The Lily directory structure, which looks like:
+
+    lilypond-0.1.48/
+    patches/
+    releases/
+    test/
+
+=back
+       
+=head1 SYNCHRONISE
+
+If you're not very quick with sending your patch, there's a good chance
+that an new release of LilyPond comes available.  In such a case (and
+sometimes for other unkown reasons :-), the maintainer will probably ask
+you to make a new patch against the latest release.
+Your best bet is to download the latest release, and apply your patch
+against this new source tree:
+
+    cd lilypond-0.1.49
+    zpatch -p0 -E < ../patches/patch-0.1.48.jcn1.gz
+
+Then, make a patch as shown above.
+
+=head1 MAINTAINER
+
+Han-Wen Nienhuys <hanwen@cs.ruu.nl>
+
+Just keep on sending those patches!
+=head1 NAME
+
+PATCHES - track and distribute your code changes
+
+=head1 DESCRIPTION
+
+This page documents how to distribute your changes to GNU LilyPond
+
+=head1 ABSTRACT
+
+Distributing a change normally goes like this:
+
+=over 5
+
+=item *
+
+make your fix/add your code 
+
+=item *
+
+generate a patch, 
+
+=item *
+
+e-mail your patch to one of the mailing lists
+gnu-music-discuss@gnu.org or bug-gnu-music@gnu.org
+(or if you're a bit shy, to the maintainer).
+
+=back
+
+=head1 GENERATING A PATCH
+
+In F<VERSION>, set TOPLEVEL_MY_PATCH_LEVEL:
+
+    VERSION:
+       ...
+       TOPLEVEL_MY_PATCH_LEVEL = jcn1
+
+In F<NEWS>, enter a summary of changes:
+
+    NEWS:
+       pl 0.1.48.jcn1
+               - added PATCHES.pod
+
+Then, type something like
+
+    make-dist
+    mv out/lilypond-0.1.48.jcn1.tar.gz ../releases
+    make-patch
+
+which leaves your patch as F<./patch-0.1.48.jcn1>.
+
+or even simpler:
+
+    release
+
+    tar-ball: ../patches/patch-0.1.48.jcn1.gz
+    patch: ../patches/patch-0.1.48.jcn1.gz
+    updeet: ../test/updeet
+
+=head1 PREREQUISITES
+
+For creating a patch you need
+
+=over 5
+
+=item *
+
+All items mentioned in F<INSTALL>.  You're not going to send a patch
+that you haven't even built, right?
+
+=item *
+
+GNU Diff
+
+=item *
+
+Python (version 1.4 or newer).  
+You can of course make a patch by hand, which would go something like:
+
+    make distclean
+    cd ..
+    diff -urN lilypond-0.1.48 lilypond-0.1.48.jcn1 > patch-0.1.48.jcn1
+
+but there are handy python scripts available.  If you're doing development,
+you'll need Python for other LilyPond scripts anyway.
+
+=item *
+
+The Lily directory structure, which looks like:
+
+    lilypond-0.1.48/
+    patches/
+    releases/
+    test/
+
+=back
+       
+=head1 SYNCHRONISE
+
+If you're not very quick with sending your patch, there's a good chance
+that an new release of LilyPond comes available.  In such a case (and
+sometimes for other unkown reasons :-), the maintainer will probably ask
+you to make a new patch against the latest release.
+Your best bet is to download the latest release, and apply your patch
+against this new source tree:
+
+    cd lilypond-0.1.49
+    zpatch -p0 -E < ../patches/patch-0.1.48.jcn1.gz
+
+Then, make a patch as shown above.
+
+=head1 MAINTAINER
+
+Han-Wen Nienhuys <hanwen@cs.ruu.nl>
+
+Just keep on sending those patches!
index dd04ca3604480d61bd53d31935f375902aa23562..37c33b2b346809f403d1de20d0785be9749c442f 100644 (file)
@@ -3,6 +3,9 @@
 
 .SUFFIXES: .pod .txt .1  .html
 
+pod2html=pod2html
+pod2groff=pod2man --center="LilyPond documentation" --section="0"\
+       --release="LilyPond $(VERSION)" $< > $@
 
 $(outdir)/%.gif: %.xpm
        xpmtoppm $< | ppmtogif > $@
@@ -24,10 +27,10 @@ $(outdir)/%.txt: $(outdir)/%.1
 $(depth)/%.txt: $(outdir)/%.txt
        cp $< $@
 
-do_pod2html=$(pod2html) --noindex --infile $< --outfile=$@;  sh $(depth)/bin/add-URLs.sh $@
+#do_pod2html=$(POD2HTML) --noindex --infile $< --outfile=$@;  sh $(depth)/bin/add-URLs.sh $@
 # do this for perl 5.003
-#      do_pod2html=$(pod2html) $<
-#      mv $(notdir $@) $(outdir)/
+
+do_pod2html=$(POD2HTML) $< ; mv $(notdir $@) $(outdir)/
 
 
 # do this for perl 5.004
index 76ad9e5ddb8806fc6c12339a0115c926e15df5fa..1237bf4a36bb928cfdab616c05f162f2083151fe 100644 (file)
@@ -9,6 +9,14 @@ are meant to be relative to the source directory)
 
 =head2 Installing
 
+Q: Wow, the webpages look really neat, but if I install the .exe file
+on my windows 3.11 machine, it doesn't work.
+
+A: The dos port is done with the cygnus W32 port of the GNU utils. It
+does I<not> work with windows 3.x; you need NT or w95 (this is not a
+recommendation, btw.  We recommend you use Unix, in particular, use
+GNU/Linux)
+
 Q: I get all kinds of errors while  compiling F<parser.cc>
 
 A: LilyPond uses features of bison version 1.25. Please confirm that