aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorMichael Witten2012-04-01 19:46:58 -0500
committerJiri Kosina2012-04-17 03:23:32 -0500
commit88f7a642cf0d6bdfa789593ba2b019ca940a3a72 (patch)
treef72bf0b03ac8f93b0ce35b262137901354d56aa7 /README
parent6d12760c9f3d961a8bfc23ba9702d12f7eea35dd (diff)
downloadkernel-omap-88f7a642cf0d6bdfa789593ba2b019ca940a3a72.tar.gz
kernel-omap-88f7a642cf0d6bdfa789593ba2b019ca940a3a72.tar.xz
kernel-omap-88f7a642cf0d6bdfa789593ba2b019ca940a3a72.zip
README: More consistent and readable white space
Mainly, this just separates paragraphs, so that the text is easier on the eyes. Signed-off-by: Michael Witten <mfwitten@gmail.com> Acked-by: Randy Dunlap <rdunlap@xenotime.net> Signed-off-by: Jiri Kosina <jkosina@suse.cz>
Diffstat (limited to 'README')
-rw-r--r--README41
1 files changed, 31 insertions, 10 deletions
diff --git a/README b/README
index 73e2c0c284dd..e6f94a636b59 100644
--- a/README
+++ b/README
@@ -65,8 +65,8 @@ INSTALLING the kernel source:
65 gzip -cd linux-3.X.tar.gz | tar xvf - 65 gzip -cd linux-3.X.tar.gz | tar xvf -
66 66
67 or 67 or
68 bzip2 -dc linux-3.X.tar.bz2 | tar xvf -
69 68
69 bzip2 -dc linux-3.X.tar.bz2 | tar xvf -
70 70
71 Replace "X" with the version number of the latest kernel. 71 Replace "X" with the version number of the latest kernel.
72 72
@@ -83,6 +83,7 @@ INSTALLING the kernel source:
83 gzip -cd ../patch-3.x.gz | patch -p1 83 gzip -cd ../patch-3.x.gz | patch -p1
84 84
85 or 85 or
86
86 bzip2 -dc ../patch-3.x.bz2 | patch -p1 87 bzip2 -dc ../patch-3.x.bz2 | patch -p1
87 88
88 Replace "x" for all versions bigger than the version "X" of your current 89 Replace "x" for all versions bigger than the version "X" of your current
@@ -142,14 +143,16 @@ BUILD directory for the kernel:
142 Using the option "make O=output/dir" allow you to specify an alternate 143 Using the option "make O=output/dir" allow you to specify an alternate
143 place for the output files (including .config). 144 place for the output files (including .config).
144 Example: 145 Example:
146
145 kernel source code: /usr/src/linux-3.X 147 kernel source code: /usr/src/linux-3.X
146 build directory: /home/name/build/kernel 148 build directory: /home/name/build/kernel
147 149
148 To configure and build the kernel, use: 150 To configure and build the kernel, use:
149 cd /usr/src/linux-3.X 151
150 make O=/home/name/build/kernel menuconfig 152 cd /usr/src/linux-3.X
151 make O=/home/name/build/kernel 153 make O=/home/name/build/kernel menuconfig
152 sudo make O=/home/name/build/kernel modules_install install 154 make O=/home/name/build/kernel
155 sudo make O=/home/name/build/kernel modules_install install
153 156
154 Please note: If the 'O=output/dir' option is used, then it must be 157 Please note: If the 'O=output/dir' option is used, then it must be
155 used for all invocations of make. 158 used for all invocations of make.
@@ -164,36 +167,49 @@ CONFIGURING the kernel:
164 only ask you for the answers to new questions. 167 only ask you for the answers to new questions.
165 168
166 - Alternative configuration commands are: 169 - Alternative configuration commands are:
170
167 "make config" Plain text interface. 171 "make config" Plain text interface.
172
168 "make menuconfig" Text based color menus, radiolists & dialogs. 173 "make menuconfig" Text based color menus, radiolists & dialogs.
174
169 "make nconfig" Enhanced text based color menus. 175 "make nconfig" Enhanced text based color menus.
176
170 "make xconfig" X windows (Qt) based configuration tool. 177 "make xconfig" X windows (Qt) based configuration tool.
178
171 "make gconfig" X windows (Gtk) based configuration tool. 179 "make gconfig" X windows (Gtk) based configuration tool.
180
172 "make oldconfig" Default all questions based on the contents of 181 "make oldconfig" Default all questions based on the contents of
173 your existing ./.config file and asking about 182 your existing ./.config file and asking about
174 new config symbols. 183 new config symbols.
184
175 "make silentoldconfig" 185 "make silentoldconfig"
176 Like above, but avoids cluttering the screen 186 Like above, but avoids cluttering the screen
177 with questions already answered. 187 with questions already answered.
178 Additionally updates the dependencies. 188 Additionally updates the dependencies.
189
179 "make defconfig" Create a ./.config file by using the default 190 "make defconfig" Create a ./.config file by using the default
180 symbol values from either arch/$ARCH/defconfig 191 symbol values from either arch/$ARCH/defconfig
181 or arch/$ARCH/configs/${PLATFORM}_defconfig, 192 or arch/$ARCH/configs/${PLATFORM}_defconfig,
182 depending on the architecture. 193 depending on the architecture.
194
183 "make ${PLATFORM}_defconfig" 195 "make ${PLATFORM}_defconfig"
184 Create a ./.config file by using the default 196 Create a ./.config file by using the default
185 symbol values from 197 symbol values from
186 arch/$ARCH/configs/${PLATFORM}_defconfig. 198 arch/$ARCH/configs/${PLATFORM}_defconfig.
187 Use "make help" to get a list of all available 199 Use "make help" to get a list of all available
188 platforms of your architecture. 200 platforms of your architecture.
201
189 "make allyesconfig" 202 "make allyesconfig"
190 Create a ./.config file by setting symbol 203 Create a ./.config file by setting symbol
191 values to 'y' as much as possible. 204 values to 'y' as much as possible.
205
192 "make allmodconfig" 206 "make allmodconfig"
193 Create a ./.config file by setting symbol 207 Create a ./.config file by setting symbol
194 values to 'm' as much as possible. 208 values to 'm' as much as possible.
209
195 "make allnoconfig" Create a ./.config file by setting symbol 210 "make allnoconfig" Create a ./.config file by setting symbol
196 values to 'n' as much as possible. 211 values to 'n' as much as possible.
212
197 "make randconfig" Create a ./.config file by setting symbol 213 "make randconfig" Create a ./.config file by setting symbol
198 values to random values. 214 values to random values.
199 215
@@ -201,17 +217,21 @@ CONFIGURING the kernel:
201 in Documentation/kbuild/kconfig.txt. 217 in Documentation/kbuild/kconfig.txt.
202 218
203 NOTES on "make config": 219 NOTES on "make config":
220
204 - having unnecessary drivers will make the kernel bigger, and can 221 - having unnecessary drivers will make the kernel bigger, and can
205 under some circumstances lead to problems: probing for a 222 under some circumstances lead to problems: probing for a
206 nonexistent controller card may confuse your other controllers 223 nonexistent controller card may confuse your other controllers
224
207 - compiling the kernel with "Processor type" set higher than 386 225 - compiling the kernel with "Processor type" set higher than 386
208 will result in a kernel that does NOT work on a 386. The 226 will result in a kernel that does NOT work on a 386. The
209 kernel will detect this on bootup, and give up. 227 kernel will detect this on bootup, and give up.
228
210 - A kernel with math-emulation compiled in will still use the 229 - A kernel with math-emulation compiled in will still use the
211 coprocessor if one is present: the math emulation will just 230 coprocessor if one is present: the math emulation will just
212 never get used in that case. The kernel will be slightly larger, 231 never get used in that case. The kernel will be slightly larger,
213 but will work on different machines regardless of whether they 232 but will work on different machines regardless of whether they
214 have a math coprocessor or not. 233 have a math coprocessor or not.
234
215 - the "kernel hacking" configuration details usually result in a 235 - the "kernel hacking" configuration details usually result in a
216 bigger or slower kernel (or both), and can even make the kernel 236 bigger or slower kernel (or both), and can even make the kernel
217 less stable by configuring some routines to actively try to 237 less stable by configuring some routines to actively try to
@@ -256,6 +276,7 @@ COMPILING the kernel:
256 are installing a new kernel with the same version number as your 276 are installing a new kernel with the same version number as your
257 working kernel, make a backup of your modules directory before you 277 working kernel, make a backup of your modules directory before you
258 do a "make modules_install". 278 do a "make modules_install".
279
259 Alternatively, before compiling, use the kernel config option 280 Alternatively, before compiling, use the kernel config option
260 "LOCALVERSION" to append a unique suffix to the regular kernel version. 281 "LOCALVERSION" to append a unique suffix to the regular kernel version.
261 LOCALVERSION can be set in the "General Setup" menu. 282 LOCALVERSION can be set in the "General Setup" menu.