From: Michael Prokop <mika@grml.org>
Date: Mon, 2 Mar 2009 17:42:10 +0000 (+0100)
Subject: Add TODO file to Debian package; update docs
X-Git-Tag: v0.9.2~14
X-Git-Url: https://git.grml.org/?p=grml2usb.git;a=commitdiff_plain;h=6c6f33917acb91227ad8b5354da5a4d275c4847c

Add TODO file to Debian package; update docs
---

diff --git a/TODO b/TODO
index b6b870f..9cd0606 100644
--- a/TODO
+++ b/TODO
@@ -1,13 +1,16 @@
 TODOs
 -----
 
-* implement missing options (--kernel, --initrd, --squashfs, --uninstall)
-* provide --create-partition[s] option
-* provide --verify to check md5sums/sha1sums of files on usb device
-* validate partition schema/layout: is the partition schema ok and the bootable flag set? (--validate)
-* implement logic for storing information about copied files (register every file in a set())
+* implement --kernel option to install specific linux26 file
+* implement --initrd option to install specific initrd file
+* implement --squashfs option to install specific squashfs file
+* implement --verify option to check md5sums/sha1sums of files on usb device
+* implement --uninstall option to remove all grml2usb files in a clean manner
+  -> implement logic for storing information about copied files (register every file in a set())
+* implement --create-partition[s] option to generate a default partition setup
+* implement --validate option to validate partition schema/layout: is the partition schema ok and the bootable flag set?
 * the last line in bootsplash (boot.msg) of syslinux should mention all installed grml flavours
-  (attention, the line should become too long :))
+  (attention, the line should NOT become too long :))
 * code improvements:
   - improve error handling wherever possible :) => especially disk full, any other known test cases?
   - use 'with open("...", "w") as f: ... f.write("...")'
diff --git a/debian/docs b/debian/docs
deleted file mode 100644
index e69de29..0000000
diff --git a/debian/rules b/debian/rules
index 2b75c85..8d38938 100755
--- a/debian/rules
+++ b/debian/rules
@@ -51,7 +51,7 @@ binary-indep: build install
 	dh_testdir
 	dh_testroot
 	dh_installchangelogs
-	dh_installdocs
+	dh_installdocs TODO
 	dh_installman grml2usb.8
 	dh_link
 	dh_strip
diff --git a/grml2usb.8.txt b/grml2usb.8.txt
index 18cd91f..27782c2 100644
--- a/grml2usb.8.txt
+++ b/grml2usb.8.txt
@@ -77,17 +77,21 @@ Force any (possible dangerous) actions requiring manual interaction (like --fat1
 
 Display usage information and exit.
 
+//////////////////////////////////////////////////////////////////////////
   *--initrd=...*::
 
 Install specified initrd instead of the default. You might want to specify
 option *--kernel* as well. (Be aware when using multiboot setup.)
 [Notice: not implemented yet.]
+//////////////////////////////////////////////////////////////////////////
 
+//////////////////////////////////////////////////////////////////////////
   *--kernel=...*::
 
 Install specified kernel instead of the default. You might want to specify
 option *--initrd* as well. (Be aware when using multiboot setup.)
 [Notice: not implemented yet.]
+//////////////////////////////////////////////////////////////////////////
 
   *--lilo-binary=...*::
 
@@ -129,15 +133,19 @@ with it you can try using the syslinux MBR instead. If that works for you please
 Note: When using the --syslinux-mbr option lilo is executed before the MBR
 is installed so the according partitions are set active.
 
+//////////////////////////////////////////////////////////////////////////
   *--squashfs=*::
 
 Install specified squashfs file instead of the default.
 [Notice: not implemented yet.]
+//////////////////////////////////////////////////////////////////////////
 
+//////////////////////////////////////////////////////////////////////////
   *--uninstall*::
 
 Uninstall grml ISO files.
 [Notice: not implemented yet.]
+//////////////////////////////////////////////////////////////////////////
 
   *-v*, *--version*::
 
@@ -349,7 +357,10 @@ but use the default bootloader (grub) instead.
 I think I've got a really cool idea!
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Please <<X7,report it to the author>>. Or even better: send us a patch. :)
+Great! Please check out
+link:http://git.grml.org/?p=grml2usb.git;a=blob;f=TODO;hb=HEAD[the TODO file].
+Feel free to <<X7,report your wishes to the author>>. Patches highly
+appreciated.
 
 I've problems with booting from USB.
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -387,6 +398,7 @@ FAT16 filesystem.
 Install specified ISO on device /dev/sdb1 and use syslinux as bootloader
 (instead of grub being the default).
 
+/////////////////////////////////////////////////////////////////
   # grml2usb --kernel=/boot/vmlinuz-2.6.28-grml --initrd=/boot/initrd.img-2.6.28-grml \
              /home/grml/grml_2008.11.iso /dev/sdb1
 
@@ -395,6 +407,7 @@ instead of the ones provided by the ISO.
 
   # grml2usb --squashfs=/grml/grml-live/grml_cd/live/grml.squashfs \
              /home/grml/grml_2008.11.iso /dev/sdb1
+/////////////////////////////////////////////////////////////////
 
 Install specified ISO on device /dev/sdb1 but use given squashfs
 file instead of the one provided by the ISO.