MAINTENANCE revision 1b8adde7ba7d5e04395c141c5400dc2cffd7d809
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik FlyktThis is a list of random notes for GRUB maintainers. If you are not a
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik Flyktmaintainer, you need to ask maintainers to do these instead of doing
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik Flyktthese yourself.
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik FlyktHow to update the online manual: (FIXME: this is obsoelete)
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik Flykt1. Copy docs/*.texi (excluding "multiboot.texi") to fencepost.gnu.org.
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik Flykt2. Make a symbolic link from ~mohit/gnudoc/gnudoc_template to the
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik Flykt directory under which *.texi were copied, if the link isn't present.
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik Flykt3. Run ``~mohit/gnudoc/gendocs.sh grub "GNU GRUB Manual"''.
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik Flykt4. Copy the contents of the directory ``manual'' to
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik Flykt gnudist.gnu.org:~ftp/gnu/Manuals/grub-VERSION (VERSION is, for
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik Flykt example, 1.0).
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik Flykt5. Run ``ln -sf grub-VERSION grub'' in gnudist.gnu.org:~ftp/gnu/Manuals.
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik Flykt7. Verify the new online manual with a WWW browser.
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik Flykt8. Update manual.html by hand.
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik FlyktHow to release a version:
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik Flykt1. Check out the source tree from the CVS from scratch.
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik Flykt2. Check if ``make distcheck'' succeeds.
631bbe71298ec892f77f44f94feb612646fe6853Patrik Flykt4. Check the resulted images, for example, using bochs.
76253e73f9c9c24fec755e485516f3b55d0707b4Dan Williams5. Copy grub-VERSION.tar.gz, grub-VERSION-i386-pc.tar.gz and
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik Flykt grub-VERSION-i386-pc.ext2fs to fencepost.gnu.org:~ftp/gnu/grub.
f12abb48fc510b8b349c05e35ba048134debaf25Patrik Flykt6. Move older files in that directory above to the directory ``old'',
f12abb48fc510b8b349c05e35ba048134debaf25Patrik Flykt if you think they are eyesores.
f12abb48fc510b8b349c05e35ba048134debaf25Patrik Flykt7. Post an announcement to bug-grub@gnu.org. It would be a good idea to
a276e6d68606861b552140cbcc003f4af10626fcTom Gundersen send a carbon copy to bug-hurd@gnu.org and
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik Flykt debian-hurd@lists.debian.org. If the announcement is for a stable
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik Flykt version, you can inform info-gnu@gnu.org as well.
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik Flykt8. Optionally, post an announcement to Freshmeat.net.
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik FlyktLegal issues:
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik Flykt1. If a patch is not significant (in size), you don't have to care about
f12abb48fc510b8b349c05e35ba048134debaf25Patrik Flykt the copyright.
631bbe71298ec892f77f44f94feb612646fe6853Patrik Flykt2. If a patch is significant, you shouldn't apply the patch to the CVS.
764aad6258eec3bd4ae62ea341ea507bd69ce628Tom Gundersen Before doing that, you must ask the contributor to assign or disclaim
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik Flykt the copyright. Send ``/gd/gnuorg/request-assign.changes'' or
a276e6d68606861b552140cbcc003f4af10626fcTom Gundersen ``/gd/gnuorg/request-assign.future'' to the contributor, and wait
a276e6d68606861b552140cbcc003f4af10626fcTom Gundersen until the FSF finishes the legal work.
a276e6d68606861b552140cbcc003f4af10626fcTom Gundersen3. You can check if a contributor has already assigned his/her copyright
76253e73f9c9c24fec755e485516f3b55d0707b4Dan Williams to the FSF by looking at ``/gd/gnuorg/copyright.list''.
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik FlyktWhat you should have in your mind:
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik Flykt1. Don't add features unnecessarily! You may think it is a Good Thing to
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik Flykt have more features, but you must be prepared for more burdens.
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik Flykt DO THAT ONLY IF YOU BELIEVE THAT THE FEATURE IS ESSENTIAL.
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik Flykt2. Don't break backward-compatibility! Don't apply any patch which could
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik Flykt break existing features. Otherwise you would receive a lot of
139b011ab81ccea1d51f09e0261a1c390115c6ffPatrik Flykt complaints. DO THAT ONLY IF YOU BELIEVE THAT THE INCOMPATIBILITY IS
76253e73f9c9c24fec755e485516f3b55d0707b4Dan Williams3. Write good code. Be not satisfied with ad hoc workarounds or quick
76253e73f9c9c24fec755e485516f3b55d0707b4Dan Williams hacks. NEVER WRITE BAD CODE.