kadischi/doc FAQ, 1.1.1.1, 1.2 INSTALL, 1.2, 1.3 README, 1.5, 1.6 TODO, 1.2, 1.3
Darko Ilic (darko)
fedora-extras-commits at redhat.com
Wed Aug 24 21:17:27 UTC 2005
Author: darko
Update of /cvs/devel/kadischi/doc
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv1983/doc
Modified Files:
FAQ INSTALL README TODO
Log Message:
We decided to move documentation to wiki at fedoraproject.org
Index: FAQ
===================================================================
RCS file: /cvs/devel/kadischi/doc/FAQ,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -u -r1.1.1.1 -r1.2
--- FAQ 21 Aug 2005 17:08:47 -0000 1.1.1.1
+++ FAQ 24 Aug 2005 21:17:25 -0000 1.2
@@ -0,0 +1 @@
+http://fedoraproject.org/wiki/KadischiFAQ
\ No newline at end of file
Index: INSTALL
===================================================================
RCS file: /cvs/devel/kadischi/doc/INSTALL,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- INSTALL 23 Aug 2005 15:57:38 -0000 1.2
+++ INSTALL 24 Aug 2005 21:17:25 -0000 1.3
@@ -1,7 +1,7 @@
-THESE ARE BASIC INSTRUCTIONS.
+THESE ARE BASIC INSTRUCTIONS.
-IT IS STRONGLY RECOMMENDED TO CONSULT README FILE BEFORE PERFORMING THE
-INSTALLATION.
+IT IS STRONGLY RECOMMENDED TO CONSULT KADISCHI TUTORIAL
+(http://fedoraproject.org/wiki/KadischiDoc) BEFORE PERFORMING THE INSTALLATION.
*******************************************************
Index: README
===================================================================
RCS file: /cvs/devel/kadischi/doc/README,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- README 24 Aug 2005 13:54:51 -0000 1.5
+++ README 24 Aug 2005 21:17:25 -0000 1.6
@@ -1,316 +1,9 @@
-1. About Kadischi
-
-1.1 What is Kadischi
-1.2 How does Kadischi work
-1.3 Bug reports
-
-2. Installation
-
-2.1 Requirements
-2.2 YUM note
-2.3 Downloading
-2.4 Installation
-2.5 Configuration
-2.6 Uninstallation
-
-3. Using Kadischi
-
-3.1 Basic instructions
-3.2 Command line options
-3.3 Running Kadischi automatically
-3.4 Customizing Live CD system
-
-4. Under the bonnet
-
-4.1 How does Kadischi work (in details)
-4.2 How does generated Live CD work
-4.3 Design notes
-4.4 Kadischi source tree
-
-A. Appendix
-
-A1. How to apply a patch
-A2. How to build a repository
-A3. Anaconda installation methods
-
-*******************************************************
-
-1. About Kadischi
-
-1.1 What is Kadischi
-
Kadischi is an application for Fedora-based Live CD generation. It takes Fedora
repository as an input and outputs a livecd iso image.
Kadischi is still in the early stage of development, but has basic functionality
and can be run successfully.
-Kadischi home page is http://fedoraproject.org/wiki/Kadischi.
-
-1.2 How does Kadischi work
-
-Basically, Kadischi uses anaconda to install the system in a temporary directory
-(specified in the configuration file) on user`s hard drive. It then executes the
-collection of scripts (stored in /usr/share/kadischi/post_install_scripts) in
-order to modify the system to run successfully in read-only environment (CD).
-After all modifications are done, Kadischi creates an initrd image, then
-compresses the system tree (actually, it creates a compressed copy, and then
-removes the original one), and finally creates iso image of the system.
-
-For more details on the process, see "Under the bonnet" section.
-
-1.3 Bug reports
-
-Until we create a bugzilla account for Kadischi, please use darko.ilic at gmail.com
-for bug reports. For general discussion, use mailing list
-https://www.redhat.com/mailman/listinfo/fedora-livecd-list and IRC channel
-#fedora-livecd on freenode (weekly status meetings are held on #fedora-livecd at
-14:00 GMT on Wednesdays).
-
------------------------------------------------------------------------------
-
-2. Installation
-
-2.1 Requirements
-
-Following packages should be installed in order to run Kadischi:
-
- * anaconda
- * busybox-anaconda
- * syslinux
- * mkisofs
- * e2fsprogs
-
-To install them, run
-
-+--------------------------------------------------------------------------------------------+
-| yum install anaconda busybox-anaconda syslinux mkisofs e2fsprogs |
-+--------------------------------------------------------------------------------------------+
-
-2.2 YUM Note
-
-You might be encounter following warning message during installing anaconda package:
-
-+-----------------------------------------------------------------------------------------------------+
-| # yum install anaconda |
-| |
-| warning: rpmts_HdrFromFdno: Header V3 DSA signature: NOKEY, key ID db42a60e |
-| public key not available for anaconda-help-10.1.0-1.noarch.rpm |
-| Retrieving GPG key from file:///etc/pki/rpm-gpg/RPM-GPG-KEY-fedora |
-| |
-| The GPG key at file:///etc/pki/rpm-gpg/RPM-GPG-KEY-fedora (0x4F2A6FD2) |
-| is already installed but is not the correct key for this package. |
-| Check that this is the correct key for the "Fedora Core 4 - i386 - Base" repository. |
-+-----------------------------------------------------------------------------------------------------+
-
-Set gpgcheck=0 in /etc/yum.repos.d/fedora.repo temporarily to install anaconda package.
-
-2.3 Downloading
-
-For now, the only way to download Kadischi is via anonymous CVS.
-
-To do that, execute the following in a terminal (type enter when prompted for
-password):
-
-+--------------------------------------------------------------------------------------------+
-| export CVSROOT=:pserver:anonymous at cvs.fedora.redhat.com:/cvs/devel |
-| cvs -z3 login |
-| cvs -z3 co kadischi |
-+--------------------------------------------------------------------------------------------+
-
-If you don`t have cvs client installed on the machine, you can install it
-running
-
-+--------------------------------------------------------------------------------------------+
-| yum install cvs |
-+--------------------------------------------------------------------------------------------+
-
-2.4 Installation
-
-Go to the root directory of the source tree, and run './autogen.sh'. It will
-configure package for building. If you would like to pass some options to
-./configure, you can pass them to ./autogen.sh and it will forward them to
-./configure.
-
-After that, you have to run 'make' in order to build the application.
-
-Run 'make install' to install the application (default location is
-/usr/share/kadischi for application files and /etc/kadischi for configuration
-files).
-
-Yet another thing you would have to do in order to run the application is to
-patch anaconda. Files that should be patched are /usr/sbin/anaconda and
-/usr/lib/anaconda/flags.py. Patches are in /usr/share/kadischi/patches dir, and
-are made against anaconda-10.2.1.5-2 (fc4 default).
-
-For patching instructions, consult "How to apply a patch" section of Appendix.
-
-2.5 Configuration
-
-Edit /etc/kadischi/build.conf and set BUILDDIR variable. BUILDDIR
-is a directory that will be used for storing temporary files (temporary
-installation will be performed in that directory). You will need
-approximately 1.5x size of desired installation available on that device. 3GB
-works fine for me.
-
-You would also have to edit file /usr/lib/anaconda/product.py and to set
-productPath (line 25) to "Fedora" (for Fedora repository).
-
-2.6 Uninstallation
-
-Go to the root directory of the source tree and run 'make uninstall'. Make sure
-there are no extra files added to the application directories (for example
-/etc/kadischi/build.conf~).
-
------------------------------------------------------------------------------
-
-3. Using Kadischi
-
-3.1 Basic instructions
-
-The basic way to run Kadischi is to type the following in a terminal
-
-+---------------------------------------------------------------------------+
-| kadischi path-to-the-repository path-to-the-iso-image |
-+---------------------------------------------------------------------------+
-
-where path to the repository can be a path on the local file system, but can
-also be a path to ftp, http or some other type of repository.
-
-Example:
-
-+---------------------------------------------------------------------------+
-| kadischi /tmp/fc4 /tmp/fedora-live.iso |
-+---------------------------------------------------------------------------+
-
-where /tmp/fc4 is a directory holding a Fedora repository. For instructions on
-creating a local repository, colsult "How to build a repository" section from
-Appendix.
-
-Example 2:
-
-+----------------------------------------------------------------------------------------------------------------------+
-| kadischi http://download.fedora.redhat.com/pub/fedora/linux/core/4/i386/os /tmp/fedora-live.iso |
-+----------------------------------------------------------------------------------------------------------------------+
-
-Example 3: (using http://fedora.redhat.com/download/mirrors.html mirror site)
-
-+----------------------------------------------------------------------------------------------------------------------+
-| kadischi http://mirrors.kernel.org/fedora/core/4/i386/os/ /tmp/fedora-live.iso |
-+----------------------------------------------------------------------------------------------------------------------+
-
-for installing from http repository. For details on available installation
-methods, consult "Anaconda installation methods" in Appendix.
-
-3.2 Command line options
-
-Type 'kadischi --help' for list of Kadischi command line options.
-
-3.3 Running Kadischi automatically
-
-Since Kadischi itself doesn`t require any interaction, and the only interaction
-that is required is the interaction with anaconda, the only thing we have to do
-is to make anaconda run automatically. This can be done using kickstart files.
-If you supply anaconda with complete kickstart file, it will run without
-prompting (if ks file is incomplete, it will prompt you only for the information
-it lacks).
-
-If you want to run Kadischi with kickstart, use --kickstart command line option:
-
-+-----------------------------------------------------------------------------------------+
-| kadischi /tmp/fc4 /tmp/fedora-live.iso --kickstart=/path/to/kickstart.cfg |
-+-----------------------------------------------------------------------------------------+
-
-Some examples of kickstart files that can be used are included in the package
-and can be found in /usr/share/kadischi/ks_examples.
-
-Another thing that metters is bringing up the user interface. Even if supplied
-with complete ks file, anaconda will bring up the interface (GUI or TUI) which
-is something we don`t want here. Luckily, anaconda can be run in command line
-mode, where no interface is initialized. So, if you want to run Kadischi in the
-background, you would do something like:
-
-+-----------------------------------------------------------------------------------------+
-| kadischi /tmp/fc4 /tmp/fedora-live.iso --kickstart=/path/to/kickstart.cfg -C |
-+-----------------------------------------------------------------------------------------+
-
-where -C stands for command line. You can also use --cmdline instead of -C.
-
-Please note that in command line mode, no interaction with anaconda is possible,
-so if you have an incomplete kickstart file, anaconda will just print an error
-message to stdout and stop (it will not abort execution).
-
-Using this two command line options you could, for example, create a cron job
-that will create fresh ISOs from rawhide repository every day.
-
-3.4 Customizing Live CD system
-
------------------------------------------------------------------------------
-
-4. Under the bonnet
-
-4.1 How does Kadischi work (in details)
-4.2 How does generated Live CD work
-4.3 Design notes
-4.4 Kadischi source tree
-
------------------------------------------------------------------------------
-
-A. Appendix
-
-A1. How to apply a patch
-
-Synopsis for the patch utility looks like
-
-+---------------------------------------------------------------------------+
-| patch [options] [originalfile [patchfile]] |
-+---------------------------------------------------------------------------+
-
-and what we need here is
-
-+------------------------------------------------------------------------------------------------+
-| patch -b /usr/sbin/anaconda /usr/share/kadischi/patches/anaconda.patch |
-| patch -b /usr/lib/anaconda/flags.py /ush/share/kadischi/patches/flags.py.patch |
-+------------------------------------------------------------------------------------------------+
-
--b stands for backup, so patch will backup your files before applying the
-patches. Backups will be named /usr/sbin/anaconda.orig and
-/usr/lib/anaconda/flags.py.orig.
-
-For more details about the patch utility, type 'man patch' or go to http://www.gnu.org/software/diffutils/manual/html_node/index.html#toc_Merging%20with%20patch
-
-A2. How to build a repository
-
-If you have Fedora installation CDs it`s a good idea to copy them to your hard
-drive and to perform installation from a harddrive repository since it`s much
-faster (and you will probably end up with several livecd builds before the right
-one). Here`s the procedure:
-
- * create the root directory for your repository (for example /tmp/fc4)
- * create subdirectories /tmp/fc4/Fedora, /tmp/fc4/Fedora/RPMS,
-/tmp/fc4/Fedora/base
- * copy the contents of cdrom:/Fedora/base directory (from disc1) to the
-/tmp/fc4/Fedora/base
- * copy the contents of cdrom:/Fedora/RPMS directory (from all 4 discs) to the
-/tmp/fc4/Fedora/RPMS
-
-And that`s it. You can use this repository with Kadischi (path to the repository
-is /tmp/fc4).
-
-Please note that this is not a regular repository, and you can`t, for example,
-use it with yum. If you would like to create a regular repository, please
-consult some other document.
-
-A3. Anaconda installation methods
-
- * method=nfs:<path> -- Use <path> for an NFS installation.
- * method=http://<path> -- Use <path> for an HTTP installation
- * method=ftp://<path> -- Use <path> for an FTP installation
- * method=hd://<dev>/<path> -- Use <path> on <dev> for a hard drive installation
- * method=cdrom -- Do a CDROM based installation.
-
-(taken from
-http://rau.homedns.org/twiki/bin/view/Anaconda/AnacondaISOLINUXOptions)
+Kadischi home page is http://fedoraproject.org/wiki/Kadischi.
-You can checkout /usr/share/doc/anaconda-${version}/install-methods.txt for
-further information.
\ No newline at end of file
+Kadischi tutorial can be found here http://fedoraproject.org/wiki/KadischiDoc.
\ No newline at end of file
Index: TODO
===================================================================
RCS file: /cvs/devel/kadischi/doc/TODO,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- TODO 23 Aug 2005 15:58:25 -0000 1.2
+++ TODO 24 Aug 2005 21:17:25 -0000 1.3
@@ -1,23 +1 @@
-This is my freeform TODO list. I find it very important and I`ll do my best to keep it up-to-date. Tasks are ordered by importance, DESC
-
-- improve documentation
-- !! examine patches to anaconda. Some steps that would anaconda normally run are skipped in --livecd mode, and it isn`t checked is it 100% safe to do
-- tweak firstboot so we could use it for system configuration
-- fix the problem with HWADDRs in /etc/sysconfig/network-scripts/ifcfg-*
-- fix the problem with fonts.dir (during system startup)
-- provide a way to strip down languages (from /usr/share/local) and docs
-(/usr/share/doc)
-- implement SquashFS (right now it works with zisofs)
-- modify syslog and other things that log to keep shorter logs
-- improve build system (work around .am and .ac files, build RPMs)
-- implement backup/restore function for config files and used data
-(use linux4all b/r as a starting point)
-- make SELinux work on live system
-
-- make kadischi forward command line options to anaconda (so it would
-be possible to pass options to anaconda)
-- modify anaconda to calculate expected size of iso image during
-package selection (when run in --livecd mode)
-- work around config file (make anaconda ignore %livecd section, make
-kadischi able to read that section)
-- create (and integrate) fancy little gui
\ No newline at end of file
+Fresh TODO list can be found at http://fedoraproject.org/wiki/KadischiTODO
\ No newline at end of file
More information about the fedora-extras-commits
mailing list