xref: /titanic_51/usr/src/grub/grub-0.97/MAINTENANCE (revision 1b8adde7ba7d5e04395c141c5400dc2cffd7d809)
1*1b8adde7SWilliam Kucharski-*- text -*-
2*1b8adde7SWilliam Kucharski
3*1b8adde7SWilliam KucharskiThis is a list of random notes for GRUB maintainers. If you are not a
4*1b8adde7SWilliam Kucharskimaintainer, you need to ask maintainers to do these instead of doing
5*1b8adde7SWilliam Kucharskithese yourself.
6*1b8adde7SWilliam Kucharski
7*1b8adde7SWilliam KucharskiHow to update the online manual: (FIXME: this is obsoelete)
8*1b8adde7SWilliam Kucharski1. Copy docs/*.texi (excluding "multiboot.texi") to fencepost.gnu.org.
9*1b8adde7SWilliam Kucharski2. Make a symbolic link from ~mohit/gnudoc/gnudoc_template to the
10*1b8adde7SWilliam Kucharski   directory under which *.texi were copied, if the link isn't present.
11*1b8adde7SWilliam Kucharski3. Run ``~mohit/gnudoc/gendocs.sh grub "GNU GRUB Manual"''.
12*1b8adde7SWilliam Kucharski4. Copy the contents of the directory ``manual'' to
13*1b8adde7SWilliam Kucharski   gnudist.gnu.org:~ftp/gnu/Manuals/grub-VERSION (VERSION is, for
14*1b8adde7SWilliam Kucharski   example, 1.0).
15*1b8adde7SWilliam Kucharski5. Run ``ln -sf grub-VERSION grub'' in gnudist.gnu.org:~ftp/gnu/Manuals.
16*1b8adde7SWilliam Kucharski6. Run ``cd grub; ln -s grub.html index.html''.
17*1b8adde7SWilliam Kucharski7. Verify the new online manual with a WWW browser.
18*1b8adde7SWilliam Kucharski8. Update manual.html by hand.
19*1b8adde7SWilliam Kucharski
20*1b8adde7SWilliam KucharskiHow to release a version:
21*1b8adde7SWilliam Kucharski1. Check out the source tree from the CVS from scratch.
22*1b8adde7SWilliam Kucharski2. Check if ``make distcheck'' succeeds.
23*1b8adde7SWilliam Kucharski3. Run ``util/grub-image''.
24*1b8adde7SWilliam Kucharski4. Check the resulted images, for example, using bochs.
25*1b8adde7SWilliam Kucharski5. Copy grub-VERSION.tar.gz, grub-VERSION-i386-pc.tar.gz and
26*1b8adde7SWilliam Kucharski   grub-VERSION-i386-pc.ext2fs to fencepost.gnu.org:~ftp/gnu/grub.
27*1b8adde7SWilliam Kucharski6. Move older files in that directory above to the directory ``old'',
28*1b8adde7SWilliam Kucharski   if you think they are eyesores.
29*1b8adde7SWilliam Kucharski7. Post an announcement to bug-grub@gnu.org. It would be a good idea to
30*1b8adde7SWilliam Kucharski   send a carbon copy to bug-hurd@gnu.org and
31*1b8adde7SWilliam Kucharski   debian-hurd@lists.debian.org. If the announcement is for a stable
32*1b8adde7SWilliam Kucharski   version, you can inform info-gnu@gnu.org as well.
33*1b8adde7SWilliam Kucharski8. Optionally, post an announcement to Freshmeat.net.
34*1b8adde7SWilliam Kucharski
35*1b8adde7SWilliam KucharskiLegal issues:
36*1b8adde7SWilliam Kucharski1. If a patch is not significant (in size), you don't have to care about
37*1b8adde7SWilliam Kucharski   the copyright.
38*1b8adde7SWilliam Kucharski2. If a patch is significant, you shouldn't apply the patch to the CVS.
39*1b8adde7SWilliam Kucharski   Before doing that, you must ask the contributor to assign or disclaim
40*1b8adde7SWilliam Kucharski   the copyright. Send ``/gd/gnuorg/request-assign.changes'' or
41*1b8adde7SWilliam Kucharski   ``/gd/gnuorg/request-assign.future'' to the contributor, and wait
42*1b8adde7SWilliam Kucharski   until the FSF finishes the legal work.
43*1b8adde7SWilliam Kucharski3. You can check if a contributor has already assigned his/her copyright
44*1b8adde7SWilliam Kucharski   to the FSF by looking at ``/gd/gnuorg/copyright.list''.
45*1b8adde7SWilliam Kucharski
46*1b8adde7SWilliam KucharskiWhat you should have in your mind:
47*1b8adde7SWilliam Kucharski1. Don't add features unnecessarily! You may think it is a Good Thing to
48*1b8adde7SWilliam Kucharski   have more features, but you must be prepared for more burdens.
49*1b8adde7SWilliam Kucharski   DO THAT ONLY IF YOU BELIEVE THAT THE FEATURE IS ESSENTIAL.
50*1b8adde7SWilliam Kucharski2. Don't break backward-compatibility! Don't apply any patch which could
51*1b8adde7SWilliam Kucharski   break existing features. Otherwise you would receive a lot of
52*1b8adde7SWilliam Kucharski   complaints. DO THAT ONLY IF YOU BELIEVE THAT THE INCOMPATIBILITY IS
53*1b8adde7SWilliam Kucharski   INEVITABLE.
54*1b8adde7SWilliam Kucharski3. Write good code. Be not satisfied with ad hoc workarounds or quick
55*1b8adde7SWilliam Kucharski   hacks. NEVER WRITE BAD CODE.
56*1b8adde7SWilliam Kucharski
57*1b8adde7SWilliam KucharskiResources:
58*1b8adde7SWilliam Kucharski* http://www.gnu.org/prep/maintain_toc.html
59*1b8adde7SWilliam Kucharski* http://www.gnu.org/prep/standards_toc.html
60*1b8adde7SWilliam Kucharski* http://www.gnu.org/server/fsf-html-style-sheet.html
61