Oops, fix option handling in sysresccd-usbstick (unedited copy/paste)
[systemrescuecd.git] / README
1 Setting up Catalyst
2 -------------------
3
4 Create a Portage tree snapshot
5 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6
7 Create a snapshot of the current source tree
8   # catalyst -C target=snapshot version_stamp=20100323 storedir="$CATALYSTDIR"
9 will create
10   $CATALYSTDIR/snapshots/portage-20100323.tar.bz2
11
12 Get Stage3 tarballs
13 ~~~~~~~~~~~~~~~~~~~
14
15 Stage3 tarballs are stored in
16   $GENTOO_MIRROR/releases/$ARCH/current-stage3/
17 For example,
18   http://distfiles.gentoo.org/releases/x86/current-stage3/stage3-i486-20100216.tar.bz2
19 Take a look at
20   http://www.gentoo.org/main/en/mirrors.xml
21 to find a mirror near you.
22
23 Grab the tarball (and put it where catalyst will find it)
24   # wget http://.../stage3-i486-20100216.tar.bz2
25   # cp stage3-i486-20100216.tar.bz2 CATALYSTDIR/builds/
26
27 Tweak *.spec files
28 ~~~~~~~~~~~~~~~~~~
29
30 You may need to adjust the
31   subarch, snapshot, and source_subpath
32 fields of the mainfiles/*.spec to match your target host, snapshot,
33 and stage3 tarball name respectively.
34
35
36 Building
37 --------
38
39 Now that everything's setup, run catalyst
40   # rebuild-kernel.sh <imagename>
41 Which will create
42   $REPOBIN/kernels-x86/
43 and...?
44
45 Finally, run
46   # recreate-iso.sh <arch>
47 to create
48   $DESTDIR/systemrescuecd-$ARCH-$VERSION-$MYDATE.iso
49   $DESTDIR/systemrescuecd-$ARCH-$VERSION-$MYDATE.tar.bz2
50
51
52 Notes
53 -----
54
55 Gentoo stages
56 ~~~~~~~~~~~~~
57
58 You can't compile with just a big pile of source, because you need a
59 compiled toolchain.  This is what Gentoo's stages take care of.  The
60 "base system" contains the necessary build tools and supporting
61 infrastructure to get things going.  The stages are:
62  1: System must be bootstrapped and the base system must be compiled.
63  2: Stage1 + bootstrapped.
64  3: Stage2 + base system compiled.
65  4: Stage3 + non-base packages.
66 See
67   http://www.gentoo.org/doc/en/faq.xml#stage12
68 for more information.
69
70 See also
71 ~~~~~~~~
72
73 http://www.gentoo-wiki.info/HOWTO_build_a_LiveCD
74 http://www.gentoo-wiki.info/HOWTO_Small_Footprint_Gentoo_on_USB
75