17c478bd9Sstevel@tonic-gate-*- text -*- 27c478bd9Sstevel@tonic-gate 37c478bd9Sstevel@tonic-gateThis is a list of random notes for GRUB maintainers. If you are not a 47c478bd9Sstevel@tonic-gatemaintainer, you need to ask maintainers to do these instead of doing 57c478bd9Sstevel@tonic-gatethese yourself. 67c478bd9Sstevel@tonic-gate 77c478bd9Sstevel@tonic-gateHow to update the online manual: (FIXME: this is obsoelete) 87c478bd9Sstevel@tonic-gate1. Copy docs/*.texi (excluding "multiboot.texi") to fencepost.gnu.org. 97c478bd9Sstevel@tonic-gate2. Make a symbolic link from ~mohit/gnudoc/gnudoc_template to the 107c478bd9Sstevel@tonic-gate directory under which *.texi were copied, if the link isn't present. 117c478bd9Sstevel@tonic-gate3. Run ``~mohit/gnudoc/gendocs.sh grub "GNU GRUB Manual"''. 127c478bd9Sstevel@tonic-gate4. Copy the contents of the directory ``manual'' to 137c478bd9Sstevel@tonic-gate gnudist.gnu.org:~ftp/gnu/Manuals/grub-VERSION (VERSION is, for 147c478bd9Sstevel@tonic-gate example, 1.0). 157c478bd9Sstevel@tonic-gate5. Run ``ln -sf grub-VERSION grub'' in gnudist.gnu.org:~ftp/gnu/Manuals. 167c478bd9Sstevel@tonic-gate6. Run ``cd grub; ln -s grub.html index.html''. 177c478bd9Sstevel@tonic-gate7. Verify the new online manual with a WWW browser. 187c478bd9Sstevel@tonic-gate8. Update manual.html by hand. 197c478bd9Sstevel@tonic-gate 207c478bd9Sstevel@tonic-gateHow to release a version: 217c478bd9Sstevel@tonic-gate1. Check out the source tree from the CVS from scratch. 227c478bd9Sstevel@tonic-gate2. Check if ``make distcheck'' succeeds. 237c478bd9Sstevel@tonic-gate3. Run ``util/grub-image''. 247c478bd9Sstevel@tonic-gate4. Check the resulted images, for example, using bochs. 257c478bd9Sstevel@tonic-gate5. Copy grub-VERSION.tar.gz, grub-VERSION-i386-pc.tar.gz and 267c478bd9Sstevel@tonic-gate grub-VERSION-i386-pc.ext2fs to fencepost.gnu.org:~ftp/gnu/grub. 277c478bd9Sstevel@tonic-gate6. Move older files in that directory above to the directory ``old'', 287c478bd9Sstevel@tonic-gate if you think they are eyesores. 297c478bd9Sstevel@tonic-gate7. Post an announcement to bug-grub@gnu.org. It would be a good idea to 307c478bd9Sstevel@tonic-gate send a carbon copy to bug-hurd@gnu.org and 317c478bd9Sstevel@tonic-gate debian-hurd@lists.debian.org. If the announcement is for a stable 327c478bd9Sstevel@tonic-gate version, you can inform info-gnu@gnu.org as well. 337c478bd9Sstevel@tonic-gate8. Optionally, post an announcement to Freshmeat.net. 347c478bd9Sstevel@tonic-gate 357c478bd9Sstevel@tonic-gateLegal issues: 367c478bd9Sstevel@tonic-gate1. If a patch is not significant (in size), you don't have to care about 377c478bd9Sstevel@tonic-gate the copyright. 387c478bd9Sstevel@tonic-gate2. If a patch is significant, you shouldn't apply the patch to the CVS. 397c478bd9Sstevel@tonic-gate Before doing that, you must ask the contributor to assign or disclaim 407c478bd9Sstevel@tonic-gate the copyright. Send ``/gd/gnuorg/request-assign.changes'' or 417c478bd9Sstevel@tonic-gate ``/gd/gnuorg/request-assign.future'' to the contributor, and wait 427c478bd9Sstevel@tonic-gate until the FSF finishes the legal work. 437c478bd9Sstevel@tonic-gate3. You can check if a contributor has already assigned his/her copyright 447c478bd9Sstevel@tonic-gate to the FSF by looking at ``/gd/gnuorg/copyright.list''. 457c478bd9Sstevel@tonic-gate 467c478bd9Sstevel@tonic-gateWhat you should have in your mind: 477c478bd9Sstevel@tonic-gate1. Don't add features unnecessarily! You may think it is a Good Thing to 487c478bd9Sstevel@tonic-gate have more features, but you must be prepared for more burdens. 497c478bd9Sstevel@tonic-gate DO THAT ONLY IF YOU BELIEVE THAT THE FEATURE IS ESSENTIAL. 507c478bd9Sstevel@tonic-gate2. Don't break backward-compatibility! Don't apply any patch which could 517c478bd9Sstevel@tonic-gate break existing features. Otherwise you would receive a lot of 527c478bd9Sstevel@tonic-gate complaints. DO THAT ONLY IF YOU BELIEVE THAT THE INCOMPATIBILITY IS 537c478bd9Sstevel@tonic-gate INEVITABLE. 547c478bd9Sstevel@tonic-gate3. Write good code. Be not satisfied with ad hoc workarounds or quick 557c478bd9Sstevel@tonic-gate hacks. NEVER WRITE BAD CODE. 567c478bd9Sstevel@tonic-gate 577c478bd9Sstevel@tonic-gateResources: 587c478bd9Sstevel@tonic-gate* http://www.gnu.org/prep/maintain_toc.html 597c478bd9Sstevel@tonic-gate* http://www.gnu.org/prep/standards_toc.html 607c478bd9Sstevel@tonic-gate* http://www.gnu.org/server/fsf-html-style-sheet.html 61