Reword the schroot session ID listing commands for people new to schroot

[mirror/dsa-wiki.git] / input / doc / schroot.mdwn

diff --git a/input/doc/schroot.mdwn b/input/doc/schroot.mdwn
index 4fecdde..e690a18 100644 (file)
--- a/input/doc/schroot.mdwn
+++ b/input/doc/schroot.mdwn
@@ -1,60 +1,63 @@
 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
-with 'schroot --begin-session -c <chroot>', run commands in sessions using
-'schroot --run-session -c <session> [-- command]', and tear down sessions
-using 'schroot --end-session -c <session>'.  You can run a limited set of
-privileged commands, for instance some of apt-get, using
-'dd-schroot-cmd -c <session> <command>'.
-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.
+When logging into Debian porterbox machine:
 
 * List available chroots:
-
+<pre><code>
        $ schroot -l
+</code></pre>
 
 * Begin a persistent schroot session on Debian unstable:
-
-       $ schroot -b -c sid -n mysid
+<pre><code>
+       # Pick your own session name:
+       $ echo -n "Session ID: " && read sessionid && schroot -b -c sid -n $sessionid
+       # or use a random one:
+       $ sessionid=$(schroot -b -c sid)
+</code></pre>
 
 * Update and upgrade Debian unstable chroot:
-
-       $ dd-schroot-cmd -c mysid apt-get update
-       $ dd-schroot-cmd -c mysid apt-get upgrade
+<pre><code>
+       $ dd-schroot-cmd -c $sessionid apt-get update
+       $ dd-schroot-cmd -c $sessionid apt-get upgrade
        [..]
        Do it for real [Y/n]: <Enter>
        [..]
+</code></pre>
 
-* Install your broken package build dependencies:
-
-       $ dd-schroot-cmd -c mysid apt-get build-dep gentoo
+* Install your build dependencies:
+<pre><code>
+       $ dd-schroot-cmd -c $sessionid apt-get build-dep hello
        [..]
        Do it for real [Y/n]: <Enter>
        [..]
+</code></pre>
 
 * Change root to Debian unstable chroot:
+<pre><code>
+       $ schroot -r -c $sessionid
+</code></pre>
 
-       $ schroot -r -c mysid
-
-* Download your broken package source:
-
-       (sid_arch-dchroot)user@porterbox:~$ apt-get source gentoo
+* Download your source:
+<pre><code>
+       (sid_arch-dchroot)user@porterbox:~$ apt-get source hello
+</code></pre>
 
 * 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:
-
+<pre><code>
        (sid_arch-dchroot)user@porterbox:~$ exit
-       $ schroot -e -c mysid
+       $ schroot -e -c $sessionid
        $ exit
+</code></pre>
+
+* List your currently open sessions:
+<pre><code>
+       $ schroot-list-sessions
+</code></pre>
+
+* List all currently open sessions:
+<pre><code>
+       $ schroot --list --all-sessions
+</code></pre>
 
 * You should be done by now. If you find any issue, please report to debian-admin@lists.debian.org.