plasmaroo 05/07/24 16:51:15 Modified: xml/htdocs/doc/en genkernel.xml Log: Update to 3.2.0 and restructure and reword (thanks to major contributions from Jimi Ayodele) and add netbooting information (thanks to contributions from Thomas Seiler).
Revision Changes Path 1.17 +712 -271 xml/htdocs/doc/en/genkernel.xml file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/genkernel.xml?rev=1.17&content-type=text/x-cvsweb-markup&cvsroot=gentoo plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/genkernel.xml?rev=1.17&content-type=text/plain&cvsroot=gentoo diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/genkernel.xml.diff?r1=1.16&r2=1.17&cvsroot=gentoo Index: genkernel.xml =================================================================== RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/genkernel.xml,v retrieving revision 1.16 retrieving revision 1.17 diff -u -r1.16 -r1.17 --- genkernel.xml 26 Jun 2005 23:50:57 -0000 1.16 +++ genkernel.xml 24 Jul 2005 16:51:15 -0000 1.17 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding="UTF-8"?> -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/genkernel.xml,v 1.16 2005/06/26 23:50:57 vanquirius Exp $ --> +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/genkernel.xml,v 1.17 2005/07/24 16:51:15 plasmaroo Exp $ --> <!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> <guide link="/doc/en/genkernel.xml"> @@ -9,460 +9,901 @@ <mail link="[EMAIL PROTECTED]">Tim Yamin</mail> </author> +<!-- [EMAIL PROTECTED] --> +<author title="Contributor"> + Jimi Ayodele +</author> + +<!-- [EMAIL PROTECTED] --> +<author title="NFS Support"> + Thomas Seiler +</author> + <abstract> -This guide intends to provide a reference of all the functions -provided by genkernel. +This guide intends to provide a reference of all the functions provided by +genkernel. </abstract> <license/> -<version>1.1.2.3</version> -<date>2005-06-26</date> +<version>1.2</version> +<date>2005-07-24</date> <chapter> <title>Introduction</title> <section> -<title>Introduction</title> +<title>Rationale</title> <body> <p> -Genkernel is designed to allow users who are not previously used to -compiling a kernel to use a similar setup to that one that is used on -the Gentoo Installation CDs which auto-detects your hardware. -</p> - -<p> -Some users may also be interested in using genkernel for hardware -which requires initialization and a working kernel before it can be -booted. Because genkernel also automatically compiles your kernel modules, -thus allowing hardware which needs to be loaded with module parameters -to be used. +For users who are not privy to kernel compilation, genkernel is a tool to +automate this process. It can help you create a kernel image akin to those +available on Gentoo Installation CDs, which are designed to auto-detect the +hardware configuration of your system. Some users may also be interested in +using genkernel for hardware requiring initialization and a working kernel +before the system starts up. Since genkernel automatically compiles your kernel +modules, you can use hardware that may require certain module parameters to be +loaded for proper operation. </p> </body> </section> + <section> -<title>Is genkernel for me?</title> +<title>Target Audience</title> <body> <p> -Genkernel is often a good choice to those who are unused to compiling -their own kernel or those who are not certain about their hardware -configurations. -</p> - -<p> -Because genkernel is designed to use a generic configuration, it -should be able to support all of your hardware - however, because all -the drivers and modules have to be compiled as well, compiling a -kernel by yourself is often much faster provided you know what you need. +If you are either uncertain about how to compile a kernel, or are just +unfamiliar with your hardware configuration, genkernel is a very handy tool. +It is designed to take the pain out of the kernel compiling process, and +supports most hardware by default. </p> <p> -Genkernel does not however, currently support booting the sytem from -LVM2/EVMS2 partitions. Users are recommended to use a manually compiled -kernel for the time being. +However, if you know what drivers are required by your system, you may be able +to further reduce the time taken to compile the kernel. This is possible since +you can direct genkernel to only build drivers relevant to your hardware. +Oftentimes, the number of drivers required by your system will be fewer +(implying a shorter kernel compilation time) than the default configuration +provides. </p> </body> </section> <section> -<title>Getting genkernel</title> +<title>Installing genkernel</title> <body> <p> -You can obtain genkernel by simply running <c>emerge genkernel</c>. Don't -forget to use the <c>-k</c> flag for emerge if you are using binary packages, -i.e. GRP. Due to the GRP packages having an older version of genkernel, the -flags are different. As a result, you should consult the <uri -link="/doc/en/handbook/handbook-x86.xml?part=1&chap=10"> -Gentoo Handbook</uri> and <path>genkernel --help</path>. +To obtain genkernel, run <c>emerge genkernel</c> from the command line. If you +are using the +<uri link="http://www.gentoo.org/doc/en/handbook/2005.0/hb-install-about.xml#doc_chap2_sect1";> +Gentoo Reference Platform</uri> (GRP), remember to install binary packages by +passing the <c>-k</c> flag to emerge. Since the GRP is bundled with an older +version of genkernel, the flags may be different. In any case, consult +<c>genkernel --help</c> for help on how to use the version of genkernel +installed on your system. </p> - + </body> </section> +</chapter> + +<chapter> +<title>Working with genkernel</title> <section> -<title>Supported platforms</title> +<title>How to use genkernel</title> <body> <p> -As of genkernel 3.0.2, the following platforms should be -supported: alpha, amd64, parisc, parisc64, ppc, ppc64, sparc, sparc64, and x86. +Although there are several ways to run genkernel, the least-intrusive approach +is provided by <c>genkernel all</c>. Here, a generic configuration which works +well for most systems is used. As was mentioned earlier, this approach is not +without drawbacks; most of the modules created are useless to the average user +and may increase compile time. Below is an illustration of a more efficient +approach, achieved by passing certain flags to genkernel as root: </p> -</body> -</section> -</chapter> +<pre caption="Running genkernel (with flags)"> +# genkernel --bootsplash --no-install --no-clean --menuconfig all +</pre> -<chapter> -<title>Genkernel usage</title> -<section> -<title>Introduction</title> -<body> +<p> +The above operation causes genkernel to create a bootsplash-enabled kernel +(<c>--bootsplash</c>) that will have to be manually installed +(<c>--no-install</c>). While preparing the kernel source tree, genkernel will +refrain from cleaning out any preexisting object files present in the source +tree (<c>--no-clean</c>). A menu-driven kernel configuration utility will be +displayed that allows the user to select which modules will be built for the +system (<c>--menuconfig</c>). +</p> <p> -Genkernel is designed to work in three modes: +There are other flags which alter the result provided by genkernel. For +instance, replacing <c>--no install</c> with the <c>--install</c> flag allows +genkernel to automatically install the new kernel in the <path>/boot</path> +directory. Using the <c>--mountboot</c> flag allows genkernel to mount your +<path>/boot</path> partition automatically, if necessary. </p> -<ul> - <li>"all" mode: this builds the kernel and the initrd</li> - <li>"kernel" mode: this only builds the kernel image</li> - <li>"initrd" mode: this only builds the initrd</li> -</ul> +<p> +Remember, genkernel is designed to make kernel compilation easy and +stress-free. For this reason, genkernel features several flags to ease the +kernel compilation effort. For example, there are flags to help with kernel +configuration, while others affect the actual compilation. Some flags even help +debug the compilation process. For those interested in further optimization, +there are flags that affect kernel assembling, packaging and even kernel -- [email protected] mailing list
