[gentoo-doc-cvs] cvs commit: genkernel.xml

[Tim Yamin]

plasmaroo    05/07/25 20:28:53

  Modified:    xml/htdocs/doc/en genkernel.xml
  Log:
  Update to 3.3; remove a few of the internal options that shouldn't be touched by users as they are reserved for internal catalyst usage.

Revision  Changes    Path
1.18      +78 -85    xml/htdocs/doc/en/genkernel.xml

file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/genkernel.xml?rev=1.18&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.18&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/genkernel.xml.diff?r1=1.17&r2=1.18&cvsroot=gentoo

Index: genkernel.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/genkernel.xml,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- genkernel.xml	24 Jul 2005 16:51:15 -0000	1.17
+++ genkernel.xml	25 Jul 2005 20:28:53 -0000	1.18
@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/genkernel.xml,v 1.17 2005/07/24 16:51:15 plasmaroo Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/genkernel.xml,v 1.18 2005/07/25 20:28:53 plasmaroo Exp $ -->
 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
 
 <guide link="/doc/en/genkernel.xml">
@@ -26,8 +26,8 @@
 
 <license/>
 
-<version>1.2</version>
-<date>2005-07-24</date>
+<version>1.3</version>
+<date>July 24, 2005</date>
 
 <chapter>
 <title>Introduction</title>
@@ -244,22 +244,18 @@
 </ul>
 
 <ul>
-  <li>
-    <b>--callback="<c>echo hello</c>"</b>: Calls the specified arguments
-    (<c>echo hello</c>, in this case) after the kernel and the relevant modules
-    have been built, but before building the initrd image. This may be useful
-    if you want to install external modules in the initrd image by emerging the
-    relevant item using the callback feature, and then redefining a genkernel
-    module group.
-  </li>
+   <li>
+      <b>--callback="<c>echo hello</c>"</b>: Calls the specified arguments
+      (<c>echo hello</c>, in this case) after the kernel and the relevant
+      modules have been built, but before building the initrd image. This may
+      be useful if you want to install external modules in the initrd image by
+      emerging the relevant item(s) with the callback feature, and then
+      redefining a genkernel module group.
+   </li>
 </ul>
 
 <ul>
    <li>
-      <b>--udev</b>: Activates support for the userspace device file system
-      (udev) in the initrd image.
-   </li>
-   <li>
       <b>--<c>no-</c>install</b>: Activates <e>[or deactivates]</e> the
       <c>make install</c> command, which installs your new kernel image,
       configuration file, initrd image and system map onto your mounted boot
@@ -390,42 +386,64 @@
 </p>
 
 <ul>
-  <li>
-    <b>--<c>no-</c>bootsplash</b>: Activates <e>[or deactivates]</e>
-    bootsplash support in the genkernel-built initrd image. The bootsplash
-    feature is supported on a limited number of architectures, and a kernel
-    that supports bootsplash is also required. Bootsplash is only supported
-    on 2.4 series kernels.
-  </li>
-  <li>
-    <b>--<c>no-</c>gensplash</b>: Activates <e>[or deactivates]</e>
-    gensplash support in the genkernel-built initrd image. The gensplash
-    utility is intended to be a replacement for bootsplash, and is designed for
-    use with 2.6.x series kernels.
-  </li>
-  <li>
-    <b>--do-keymap-auto</b>: Specifies which keymap to use during the boot
-    sequence.
-  </li>
-  <li>
-      <b>--lvm2</b>: Includes support for storage using via Logical Volume
-      Management (LVM2) from static binaries, if available to the system.
-      Relevant (static) LVM2 binaries are compiled if they are unavailable.
-      Be sure to install the lvm2 package on your system with <c>emerge
-      lvm2</c> before enabling this flag, and review the <uri
+   <li>
+      <b>--<c>no-</c>bootsplash</b>: Activates <e>[or deactivates]</e> support
+      for <uri link="http://www.bootsplash.org/">bootsplash</uri> in the
+      genkernel-built initrd image. The bootsplash feature is supported on a
+      limited number of architectures, and a kernel that supports bootsplash
+      is also required.
+   </li>
+   <li>
+      <b>--<c>no-</c>gensplash</b>: Activates <e>[or deactivates]</e> support
+      for <uri link="http://dev.gentoo.org/~spock/projects/gensplash/">gensplash</uri>
+      support in the genkernel-built initrd image. The gensplash utility is
+      intended to be a replacement for bootsplash, and is designed for use with
+      2.6.x series kernels. To override the default theme used by gensplash,
+      use <b>--gensplash=<c>PreferredTheme</c></b> (where <c>PreferredTheme</c>
+      is the title of one of the directories inside the
+      <path>/etc/splash/</path> directory.
+   </li>
+   <li>
+      <b>--gensplash-res=<c>PreferredResolution</c></b>: This flag allows you
+      to select which splash screen resolutions will be supported in the initrd
+      during the start-up of the system. This is useful for two reasons: First,
+      you are able to select only the splash screen resolution(s) relevant to
+      your system. Second, you avoid the unnecessary increase in the disk space
+      required by initrd (since the initrd does not have to support resolutions
+      that are irrelevant for your system configuration.) However, you may want
+      to omit this flag if the kernel is being compiled for an Installation CD;
+      this allows gensplash support for all possible resolutions.
+   </li>
+   <li>
+      <b>--do-keymap-auto</b>: Force keymap selection during the boot
+      sequence.
+   </li>
+   <li>
+      <b>--lvm2</b>: Includes support for storage using via <uri 
+      link="http://sources.redhat.com/lvm2/">Logical Volume Management</uri>
+      (LVM2) from <e>static</e> binaries, if available to the system. Relevant
+      (static) LVM2 binaries are compiled if they are unavailable. Be sure to
+      install the lvm2 package on your system with <c>emerge lvm2</c> before
+      enabling this flag, and review the <uri
       link="http://www.gentoo.org/doc/en/lvm2.xml">Gentoo LVM2
       Installation</uri> guide.
    </li>
    <li>
-      <b>--evms2</b>: Includes support for storage using the Enterprise Volume
-      Management System (EVMS/EVMS2), if available. Be sure to install the evms
-      package on your system with <c>emerge evms</c> before using this flag.
+      <b>--evms2</b>: Includes support for storage using the <uri 
+      link="http://evms.sourceforge.net/">Enterprise Volume Management
+      System</uri> (EVMS2), if available. Be sure to install the evms package
+      on your system with <c>USE=static emerge evms2</c> before using this
+      (genkernel) flag. <e>(Omitting the </e><c>USE=static</c> <e>flag during
+      package installation will fail to include the necessary static binaries.)
+      </e>
    </li>
    <li>
-      <b>--dmraid</b>: Includes support for the DMRAID, the utility which
-      creates RAID mappings using the kernel device-mapper subsystem. DMRAID
-      discovers, activates, deactivates and displays properties of software
-      RAID sets (ATARAID, for example) and contained DOS partitions.
+      <b>--dmraid</b>: Includes support for <uri 
+      link="http://people.redhat.com/~heinzm/sw/dmraid/readme">DMRAID</uri>;
+      the utility which creates RAID mappings using the kernel device-mapper
+      subsystem. DMRAID discovers, activates, deactivates and displays
+      properties of software RAID sets (ATARAID, for example) and contained
+      DOS partitions.
    </li>
    <li>
       <b>--linuxrc=/path/to/your/linuxrc</b>: Specifies a user-created 
@@ -443,6 +461,11 @@
       <b>--tempdir=/path/to/new/tempdir/</b>: Specifies the location of the
       temporary directory used by genkernel while compiling the kernel.
    </li>
+   <li>
+      <b>--unionfs</b>: Includes support for the <uri 
+      link="http://www.fsl.cs.sunysb.edu/project-unionfs.html">Unification File
+      System</uri> in the initrd image.
+   </li>
 </ul>
 
 </body>
@@ -465,40 +488,10 @@
       partition on a file system (if needed).
    </li>
    <li>
-      <b>--arch-override=<c>someArch</c></b>: Overrides the architecture
-      genkernel assumes for the kernel compilation process. This flag is useful
-      if the auto-detection mechanism fails (please file a bug if it does!) or
-      if you wish to cross-compile a kernel. The list of supported
-      architectures is available in the <path>/usr/share/genkernel/</path>
-      directory.
-   </li>
-</ul>
-
-<ul>
-   <li>
-      <b>--busybox-config=<path>/path/to/busybox-config</path></b>: Overrides
-      the default Busybox configuration with the specified file.
-   </li>
-   <li>
-      <b>--busybox-bin=<path>/path/to/busybox-binary.tar.bz2</path></b>: Using 
-      this option means that a (static) Busybox binary will not be compiled;
-      the specified tarball would be used instead.
-   </li>
-</ul>
-
-<ul>
-   <li>
-      <b>--maxkernpackage=<path>/output/to/yourkernel.tar.bz2</path></b>:
-      Creates a package that includes the kernel, the initrd image, the
-      kernel's modules (located in <path>/lib/modules/</path>) and
-      configuration file.
-   </li>
-   <li>
-      <b>--minkernpackage=<path>/output/to/yourkernel.tar.bz2</path></b>:
-      Creates a package that includes the kernel, and initrd image. The



-- 
gentoo-doc-cvs@g.o mailing list