Improve schroot documentation
authorHéctor Orón Martínez <zumbi@debian.org>
Sun, 16 Jun 2013 12:13:08 +0000 (14:13 +0200)
committerHéctor Orón Martínez <zumbi@debian.org>
Sun, 16 Jun 2013 12:13:08 +0000 (14:13 +0200)
Signed-off-by: Héctor Orón Martínez <zumbi@debian.org>
input/doc/schroot.mdwn

index 6266cc4..4fecdde 100644 (file)
@@ -1,6 +1,9 @@
 using schroot in debian.org porterboxes
 =======================================
 
+When logging into Debian porterbox machine, it should display similar message:
+
+<pre><code>
 Welcome to porterbox.debian.org, the Debian arch porterbox.
 
 See 'schroot -l' for a list of available chroots.  Start new sessions
@@ -13,4 +16,45 @@ Use 'schroot --list --all-sessions' or 'schroot-list-sessions [<userglob>]'
 to list (your) open sessions.
 
 This server is hosted at data centre.
+</code></pre>
+
+The previous description is rather compact and dense, so let's try to describe the usage in more friendly way.
+
+* List available chroots:
+
+       $ schroot -l
+
+* Begin a persistent schroot session on Debian unstable:
+
+       $ schroot -b -c sid -n mysid
+
+* Update and upgrade Debian unstable chroot:
+
+       $ dd-schroot-cmd -c mysid apt-get update
+       $ dd-schroot-cmd -c mysid apt-get upgrade
+       [..]
+       Do it for real [Y/n]: <Enter>
+       [..]
+
+* Install your broken package build dependencies:
+
+       $ dd-schroot-cmd -c mysid apt-get build-dep gentoo
+       [..]
+       Do it for real [Y/n]: <Enter>
+       [..]
+
+* Change root to Debian unstable chroot:
+
+       $ schroot -r -c mysid
+
+* Download your broken package source:
+
+       (sid_arch-dchroot)user@porterbox:~$ apt-get source gentoo
+
+* You should be able to reproduce your issue, hack on the package, fix the bug. Once you are done with your work, please, finish your schroot session:
+
+       (sid_arch-dchroot)user@porterbox:~$ exit
+       $ schroot -e -c mysid
+       $ exit
 
+* You should be done by now. If you find any issue, please report to debian-admin@lists.debian.org.