update documentation

5 files changed, 90 insertions, 4 deletions

diff --git a/README b/README
index b6e1da8..e0aca06 100644
--- a/README
+++ b/README
@@ -26,6 +26,7 @@ You might also want the Debian Live manuals:
 
 Once the above build requirements are satisfied:
 
+    lb clean --purge
     lb config
     lb build
 
diff --git a/TODO b/TODO
new file mode 100644
index 0000000..e35581e
--- /dev/null
+++ b/TODO
@@ -0,0 +1,9 @@
+- add vim-nox and lsof back into package lists
+- keyring stuff: config/archives/any-repo.key.{binary,chroot}
+- copy in torouterui package, add dependancies
+- custom kernel
+    http://live.debian.net/manual/html/live-manual.en.html#411
+- determine which configurations can be settled using debconf preseeds
+    http://live.debian.net/manual/html/live-manual.en.html#495
+- set user password
+    http://live.debian.net/manual/html/live-manual.en.html#505
diff --git a/auto/config b/auto/config
index 95e08eb..704bfe9 100755
--- a/auto/config
+++ b/auto/config
@@ -21,9 +21,12 @@ lb config noauto \
     --bootstrap-qemu-arch armel \
     --bootstrap-qemu-static /usr/bin/qemu-arm-static \
     --keyring-packages "debian-archive-keyring deb.torproject.org-keyring" \
-    --bootappend-live "boot=live config username=torouter" \
+    --bootappend-live "console=ttyS0,115200 boot=live config username=torouter hostname=torouter live-media=/dev/sdb1 live-media-timeout=10 debug plainroot" \
     "${@}"
 
-# Note: chroot filesystem should be 'squashfs' for final images, 'none' for
-# development
-# Note: bootappend-live options are ignored when booting from u-boot
+# Note: chroot filesystem should be 'squashfs' for production images (?), or
+# 'none' for development (easier to modify and debug rootfs)
+
+# Note: bootappend-live options are ignored when booting from u-boot, but are
+# included here for clarity. check ../doc for most up-to-date recommended boot
+# flags
diff --git a/doc/debian-live-problems.txt b/doc/debian-live-problems.txt
new file mode 100644
index 0000000..0ca005d
--- /dev/null
+++ b/doc/debian-live-problems.txt
@@ -0,0 +1,55 @@
+
+Always use the unstable version of live-build in your host build machine. At
+the time of writing this means version 3.0~a67-1. You can grab the one-off .deb
+here:
+
+    http://packages.debian.org/sid/live-build
+
+### Errors when building flat ("plain") filesystem images
+
+When building a chroot-filesystem=none image, if you encounter:
+
+    cp: cannot create regular file `binary/live/filesystem.packages': No such file or directory
+
+You will need to:
+
+    mkdir binary/live
+    rm -rf cache/binary_rootfs
+
+If you don't run the second line as well, you will get the error:
+
+    cp: cannot stat `cache/binary_rootfs/filesystem.*': No such file or directory
+
+### mksquashfs Segfaults in qemu
+
+mksquashfs always segfaults when run inside of qemu. Perhaps due to large
+memory requirements of mksquashfs?
+
+One hack workaround is to install the squashfs-tools in the host build system,
+then edit the file /usr/lib/live/build/binary_rootfs and around line 377
+comment out:
+
+    Chroot chroot "mksquashfs chroot filesystem.squashfs ${MKSQUASHFS_OPTIONS}"
+
+and insert:
+
+    cd chroot
+    mksquashfs chroot filesystem.squashfs ${MKSQUASHFS_OPTIONS}
+    cd ..
+
+Previously tried adding the following mksquashfs arguments, but they didn't fix
+the problem:
+
+    export MKSQUASHFS_OPTIONS="-processors 1 -read-queue 8 -write-queue 16 -fragment-queue 8"
+
+### squashfs image too small
+
+The Calculate_partition_size function seems to be too optimistic; sometimes
+images will not fit in the generated partitions.
+
+Add the following below line 132 of /usr/lib/live/build/binary_hdd in your host
+environment to add an extra 50MB to the partition size (probably way more than
+necessary):
+
+    DU_DIM="$(echo 50 + $DU_DIM | bc)"
+
diff --git a/doc/dreamplug.txt b/doc/dreamplug.txt
new file mode 100644
index 0000000..b7f8fc1
--- /dev/null
+++ b/doc/dreamplug.txt
@@ -0,0 +1,18 @@
+
+# u-boot Configuration
+
+You need a recent version of u-boot; search the internet for install/flash
+instructions.
+
+Use the following boot arguments:
+
+    set x_bootcmd_kernel ext2load usb 1:1 0x6400000 live/uImage
+    set x_bootcmd_initrd ext2load usb 1:1 0x6900000 live/uInitrd
+    set x_bootargs_root root=/dev/sdb1 rootdelay=4
+    set x_bootargs console=ttyS0,115200 boot=live config username=torouter hostname=torouter live-media=/dev/sdb1 live-media-timeout=10 debug plainroot
+
+# Links
+
+Random notes on the DreamPlug:
+http://www.madore.org/~david/linux/dreamplug.html
+