Gentoo Archives: gentoo-doc-cvs

From: "Joshua Saddler (nightmorph)" <nightmorph@g.o>
To: gentoo-doc-cvs@l.g.o
Subject: [gentoo-doc-cvs] gentoo commit in xml/htdocs/doc/en: genkernel.xml
Date: Thu, 20 Jan 2011 07:51:50
Message-Id: 20110120075138.0994820054@flycatcher.gentoo.org
1 nightmorph 11/01/20 07:51:37
2
3 Modified: genkernel.xml
4 Log:
5 bring genkernel.xml up-to-date with some changes from sping. also removed the 'obsolete' disclaimer.
6
7 Revision Changes Path
8 1.35 xml/htdocs/doc/en/genkernel.xml
9
10 file : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/doc/en/genkernel.xml?rev=1.35&view=markup
11 plain: http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/doc/en/genkernel.xml?rev=1.35&content-type=text/plain
12 diff : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/doc/en/genkernel.xml?r1=1.34&r2=1.35
13
14 Index: genkernel.xml
15 ===================================================================
16 RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/genkernel.xml,v
17 retrieving revision 1.34
18 retrieving revision 1.35
19 diff -u -r1.34 -r1.35
20 --- genkernel.xml 7 Dec 2010 20:49:23 -0000 1.34
21 +++ genkernel.xml 20 Jan 2011 07:51:37 -0000 1.35
22 @@ -1,8 +1,8 @@
23 <?xml version="1.0" encoding="UTF-8"?>
24 -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/genkernel.xml,v 1.34 2010/12/07 20:49:23 nightmorph Exp $ -->
25 +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/genkernel.xml,v 1.35 2011/01/20 07:51:37 nightmorph Exp $ -->
26 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
27
28 -<guide disclaimer="obsolete">
29 +<guide>
30 <title>Gentoo Linux Genkernel Guide</title>
31
32 <author title="Author">
33 @@ -32,8 +32,8 @@
34 <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
35 <license/>
36
37 -<version>4</version>
38 -<date>2010-12-07</date>
39 +<version>5</version>
40 +<date>2011-01-19</date>
41
42 <chapter>
43 <title>Introduction</title>
44 @@ -42,14 +42,12 @@
45 <body>
46
47 <p>
48 -For users who are not privy to kernel compilation, genkernel is a tool to
49 -automate this process. It can help you create a kernel image akin to those
50 +For users who don't want to manually compile their kernels, genkernel is a tool
51 +to automate this process. It can help you create a kernel image akin to those
52 available on Gentoo Installation CDs, which are designed to auto-detect the
53 hardware configuration of your system. Some users may also be interested in
54 using genkernel for hardware requiring initialization and a working kernel
55 -before the system starts up. Since genkernel automatically compiles your kernel
56 -modules, you can use hardware that may require certain module parameters to be
57 -loaded for proper operation.
58 +before the system starts up.
59 </p>
60
61 </body>
62 @@ -81,13 +79,9 @@
63 <body>
64
65 <p>
66 -To obtain genkernel, run <c>emerge genkernel</c> from the command line. If you
67 -are using the <uri link="/doc/en/handbook/2008.0/hb-install-about.xml">Gentoo
68 -Reference Platform</uri> (GRP), remember to install binary packages by passing
69 -the <c>-k</c> flag to emerge. Since the GRP is bundled with an older version
70 -of genkernel, the flags may be different. In any case, consult <c>genkernel
71 ---help</c> for help on how to use the version of genkernel installed on your
72 -system.
73 +To obtain genkernel, run <c>emerge genkernel</c> from the command line. Consult
74 +<c>genkernel --help</c> for help on how to use the version of genkernel
75 +installed on your system.
76 </p>
77
78 </body>
79 @@ -127,7 +121,8 @@
80 There are other flags which alter the result provided by genkernel. For
81 instance, replacing <c>--no-install</c> with the <c>--install</c> flag allows
82 genkernel to automatically install the new kernel in the <path>/boot</path>
83 -directory. Using the <c>--mountboot</c> flag allows genkernel to mount your
84 +directory, and will create symlinks for you if <c>--symlink</c> is specified.
85 +Using the <c>--mountboot</c> flag allows genkernel to mount your
86 <path>/boot</path> partition automatically, if necessary.
87 </p>
88
89 @@ -142,10 +137,12 @@
90 </p>
91
92 <p>
93 -The rest of this chapter examines the functionality of various flags and
94 -actions available for genkernel. Some of the flags have variants which perform
95 -a converse operation. The converse variants carry the <b><c>no-</c></b> prefix,
96 -and their effects are enclosed within the square brackets, [].
97 +The rest of this chapter examines the functionality of various flags,
98 +configuration variables, and actions available for genkernel. For a more
99 +completel list, please refer to <c>man genkernel</c> and the comments in
100 +<path>/etc/genkernel.conf</path>. Some of the flags have variants which
101 +perform a converse operation. The converse variants carry the <b><c>no-</c></b>
102 +prefix, and their effects are enclosed within the square brackets, [].
103 </p>
104
105 </body>
106 @@ -263,7 +260,7 @@
107 compiled modules will be installed as well.
108 </li>
109 <li>
110 - <b>--<c>no-</c>ramdisk-modules</b>: Refrains from copying any modules to the
111 + <b>--no-ramdisk-modules</b>: Refrains from copying any modules to the
112 genkernel-created initrd image. This flag is an exception to the rule about
113 the <c>no-</c> prefix; omission of this prefix creates an invalid genkernel
114 flag.
115 @@ -443,6 +440,17 @@
116 the value of crypt_root (and real_root shall be the unencrypted device LUKS
117 creates).
118 </li>
119 + <li>
120 + <b>--disklabel</b>: Adds support for disk label and UUID support to your
121 + initrd.
122 + </li>
123 + <li>
124 + <b>--iscsi</b>: Adds support for iSCSI to your initrd.
125 + </li>
126 + <li>
127 + <b>--multipath</b>: Adds support for <uri
128 + link="/doc/en/multipath.xml">Multipath</uri> to your initrd.
129 + </li>
130 <li>
131 <b>--linuxrc=/path/to/your/linuxrc</b>: Specifies a user-created
132 <e>linuxrc</e> &mdash; a script that is initialized during the start-up
133 @@ -532,12 +540,8 @@
134
135 <ol>
136 <li>
137 - Add <c>root=/dev/ram0</c> and <c>init=/linuxrc</c> to the kernel parameters
138 - passed to the kernel image.
139 - </li>
140 - <li>
141 - Add <c>real_root=/dev/hda3</c>, for example, to the kernel parameters
142 - passed to the kernel image, if <path>/dev/hda3</path> contains your root
143 + Add <c>real_root=/dev/sda3</c>, for example, to the kernel parameters
144 + passed to the kernel image, if <path>/dev/sda3</path> contains your root
145 partition.
146 </li>
147 <li>
148 @@ -577,8 +581,8 @@
149
150 <p>
151 Fortunately, there is a configuration file where most of the basic options can
152 -be set (or changed) as necessary. What follows is a rundown of the more
153 -relevant options:
154 +be set (or changed) as necessary: <path>/etc/genkernel.conf</path>. What follows
155 +is a rundown of the more relevant options:
156 </p>
157
158 <ul>
159 @@ -636,6 +640,10 @@
160 </li>
161 </ul>
162
163 +<note>
164 +More options are described in <path>/etc/genkernel.conf</path>.
165 +</note>
166 +
167 <p>
168 By choosing the appropriate options in <path>/etc/genkernel.conf</path>, you
169 can halve the number of flags passed to genkernel from the command line: