X-Git-Url: http://git.tremily.us/?a=blobdiff_plain;f=README;h=ef41380b1d3e77298260212dd79124fd83b912b0;hb=d7c96f12c2c20165ab0b8c410366846a91e859da;hp=e927f1e79cafd2e1d9a310462ca42d4881a753a4;hpb=fe3786e8f030814dcb7da0e08572ed937645f542;p=catalyst.git diff --git a/README b/README index e927f1e7..ef41380b 100644 --- a/README +++ b/README @@ -1,132 +1,62 @@ -catalyst is released under the GNU General Public License version 2, -and is copyright Gentoo Technologies, Inc. Will be adding official -COPYING file and source file preambles soon. +# $Id$ -How do I use this thing? +Licensing ======================== -Here's how you use catalyst. These instructions are for people using -the cvs version of catalyst, not the to-be-created ebuild version. +Originally, Catalyst was copyrighted by the Gentoo Foundation, Inc. and was +released under the terms of the GNU General Public License v.2.1. Since this +is a fork of that project, all new code is no longer copyrighted to the Gentoo +Foundation. Currently, copyright is held by the individual authors for their +contributions. For more information, please consult COPYING. -First, check out the gentoo/src/catalyst tree (which I'm guessing you -have done.) Then, create an /etc/catalyst.conf file that looks like -this: - -distdir="/mnt/misc/distfiles" -options="ccache pkgcache" -sharedir="/home/drobbins/cvs/gentoo/src/catalyst" - -The "sharedir" variable tells catalyst where to find its various -plugins, and should point to the main catalyst directory that you -checked out. the "options" variable is used to turn on .tbz2 package -caching, which is off by default (you'll likely want it on, however.) -Also, "distdir" is used here to tell catalyst where to look/store -distfiles. The default is "/usr/portage/distfiles". - -Here are other variables you can set, and their default values. -Please remember that *strings must be quoted*, as /etc/catalyst.conf -uses python syntax: - -storedir /var/tmp/catalyst (where to build/write stuff) -sharedir /usr/share/catalyst (where our plugins/scripts are) -distdir /usr/portage/distfiles (where our distfiles are) -portdir /usr/portage (where to grab snapshots from) -options ccache what catalyst options are enabled - -You may also want to create a /usr/bin/catalyst symlink that points -to the real location of your catalyst executable script. - -Creating a Portage tree snapshot -================================ - -First, make sure that your Portage tree is up-to-date as of 06 Nov 2003 -at the earliest, and that portage-2.0.49-r15 or 16 is unmasked for your -specific build. These ebuilds (as of 06 Nov 2003) contain important fixes -to allow catalyst to build properly. If you're not using the default-x86-1.4 -profile for building, please take a look at this profile and ensure that -you are relatively in-sync with it. In particular, make sure that the -GRP_STAGE23_USE variable is set in make.defaults, since catalyst uses -this variable for building stage2 and stage3. - -Before building anything, you need to generate a snapshot of the portage -tree that catalyst should use for building. To do this, ensure that your -to-be-snapshotted portage tree is at /usr/portage, or set the "portdir" -variable in /etc/catalyst.conf to point to the appropriate location, and -then type: - -# catalyst target=snapshot version_stamp=20031102 - -This will create the following file, assuming a /var/tmp/catalyst "storedir" -setting: +Disclaimer +======================== -/var/tmp/catalyst/snapshots/portage-20031102.tar.bz2 +This software is covered by no warranty or guarantee of functionality. It is +provided to the public for use in creating source-based distributions in a +simple and reproducable manner. Use at your own risk. -Grabbing a "seed" stage +Requirements ======================= -Now, you need to grab a "seed" stage1, 2 or 3 tarball from somewhere to -use to build other stages. Put the stage in /var/tmp/catalyst/builds//; - -For example, if I have a stage3-pentium4-20031102.tar.bz2 file, I'd put it in: +- Python 2.4 or greater (may still work with 2.3) +- An ebuild repository snapshot (or an ebuild tree to create one) +- A generic stage3 tarball for your architecture +- shash for digest support -/var/tmp/catalyst/builds/default-x86-1.4/stage3-pentium4-20031102.tar.bz2 - -...since that pentium4 stage was built using the "default-x86-1.4" profile. - -Building your first stage -========================= - -Once you have your seed stage, you're now ready to build your first new stage. -Here is a guideline for what components you'll need to build each type of stage: - -stage1 requires "generic" (ie. "x86" or "ppc") stage2 or 3 -NOTE: you can't use a stage1 to build a stage1 - -stage2 requires "generic" stage1 (the only kind you should have :) - -stage3 requires stage2 of same type (ie. to build a "pentium3" stage3, you need -a "pentium3" stage2, etc.) - -** Currently, only "stage1", "stage2" and "stage3" targets are supported. ** - -Of course, to build each stage you will also need the Portage tree snapshot -that you created above. - -To build a stage, type a command like this: - -# catalyst subarch=x86 version_stamp=20031102 target=stage2 rel_type=default rel_version=1.4 snapshot=20031102 source_subpath=default-x86-1.4/stage1-x86-20031102 +What is catalyst? +======================== -Wow -- that's a huge command! What does it mean? Let's look at the various arguments: +Catalyst is a release building tool, used by Gentoo Linux. With catalyst, +you are able to completely customize your Gentoo install by customizing +the very tools that are used to install a system. Official Gentoo Linux release +media is built with catalyst. -cmdline arg meaning ------------ ------- -subarch=x86 build "generic" x86 stage (could also be "pentium3", "athlon-xp", "g4", etc.) -version_stamp=20031102 give this stage being built a version stamp of "20031102" -target=stage2 the type of stage we want to build is a stage2 -rel_type=default use a "default--??" profile (other possibilities: "hardened", etc.) -rel_version=1.4 use a "??--1.4" profile (note: mainarch is auto-determined from the subarch you provide) -snapshot=20031102 use the Portage tree snapshot you created that has the "20031102" version_stamp -source_subpath=default-x86-1.4/stage1-x86-20031102 - To build our stage2, use a stage1 found at /var/tmp/catalyst/builds/ + this path. You are responsible - for ensuring that you choose an appopriate source stage for building your desired target stage. +Catalyst is capable of: -After you type this command, building should begin, and hopefully complete -successfully, at which point the following tarball will be created: +- Building installation stages +- Building bootable LiveCDs +- Building GRP (Gentoo Reference Platform) sets +- Setting up a Tinderbox target for test building +- Building netboot images -/var/tmp/catalyst/builds/default-x86-1.4/stage2-x86-20031102.tar.bz2 +Configuring catalyst +======================== -The build directory used to build this stage can be found at: +After emerging/installing catalyst, the first (and probably only) thing +that you will have to do is edit /etc/catalyst/catalyst.conf to your liking. -/var/tmp/catalyst/tmp/default-x86-1.4/stage2-x86-20031102/ +If you are not using an ebuild for the installation, you should create a +/etc/catalyst directory, and copy catalyst.conf and catalystrc from the +distribution tarball's files directory. -Building x86 stages on amd64 -============================ +Example catalyst.conf: -Catalyst currently supports building x86 stages on 64-bit AMD64 systems. To do -this, simply use as you would on x86, but ensure that the linux32 ebuild is -emerged before starting. Catalyst will detect that you are building a 32-bit -stage and will use the linux32 tool automatically when setting up chroots. -Everything should work identically to if you were using a 32-bit system. +distdir="/usr/portage/distfiles" +options="pkgcache kerncache" +sharedir="/usr/lib/catalyst" -Questions, bug reports: -drobbins@gentoo.org +There are many more options that can be set, but those defaults are good +for out of the box operation. For more documentation on what you can do +with catalyst, please check the man page or the online documentation at +http://www.gentoo.org/proj/en/releng/catalyst.