aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorRandy Dunlap2008-02-29 16:21:53 -0600
committerSam Ravnborg2009-01-02 13:43:25 -0600
commit2af238e455ef5fd31c2f7a06c2db3f13d843b9bf (patch)
tree9a1da45a4b81a03f25742a57843228362ca66fc5 /README
parent80a7d1d991e35b0370c0396f36f6a076869a6bac (diff)
downloadkernel-omap-2af238e455ef5fd31c2f7a06c2db3f13d843b9bf.tar.gz
kernel-omap-2af238e455ef5fd31c2f7a06c2db3f13d843b9bf.tar.xz
kernel-omap-2af238e455ef5fd31c2f7a06c2db3f13d843b9bf.zip
kbuild: make *config usage docs
Create a kconfig user assistance guide, with a few tips and hints about using menuconfig, xconfig, and gconfig. Mostly contains user interface, environment variables, and search topics, along with mini.config/custom.config usage. Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com> Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
Diffstat (limited to 'README')
-rw-r--r--README32
1 files changed, 20 insertions, 12 deletions
diff --git a/README b/README
index 159912cf5155..90a07658ede1 100644
--- a/README
+++ b/README
@@ -52,11 +52,11 @@ DOCUMENTATION:
52 52
53 - The Documentation/DocBook/ subdirectory contains several guides for 53 - The Documentation/DocBook/ subdirectory contains several guides for
54 kernel developers and users. These guides can be rendered in a 54 kernel developers and users. These guides can be rendered in a
55 number of formats: PostScript (.ps), PDF, and HTML, among others. 55 number of formats: PostScript (.ps), PDF, HTML, & man-pages, among others.
56 After installation, "make psdocs", "make pdfdocs", or "make htmldocs" 56 After installation, "make psdocs", "make pdfdocs", "make htmldocs",
57 will render the documentation in the requested format. 57 or "make mandocs" will render the documentation in the requested format.
58 58
59INSTALLING the kernel: 59INSTALLING the kernel source:
60 60
61 - If you install the full sources, put the kernel tarball in a 61 - If you install the full sources, put the kernel tarball in a
62 directory where you have permissions (eg. your home directory) and 62 directory where you have permissions (eg. your home directory) and
@@ -187,14 +187,9 @@ CONFIGURING the kernel:
187 "make randconfig" Create a ./.config file by setting symbol 187 "make randconfig" Create a ./.config file by setting symbol
188 values to random values. 188 values to random values.
189 189
190 The allyesconfig/allmodconfig/allnoconfig/randconfig variants can 190 You can find more information on using the Linux kernel config tools
191 also use the environment variable KCONFIG_ALLCONFIG to specify a 191 in Documentation/kbuild/make-configs.txt.
192 filename that contains config options that the user requires to be 192
193 set to a specific value. If KCONFIG_ALLCONFIG=filename is not used,
194 "make *config" checks for a file named "all{yes/mod/no/random}.config"
195 for symbol values that are to be forced. If this file is not found,
196 it checks for a file named "all.config" to contain forced values.
197
198 NOTES on "make config": 193 NOTES on "make config":
199 - having unnecessary drivers will make the kernel bigger, and can 194 - having unnecessary drivers will make the kernel bigger, and can
200 under some circumstances lead to problems: probing for a 195 under some circumstances lead to problems: probing for a
@@ -231,6 +226,19 @@ COMPILING the kernel:
231 - If you configured any of the parts of the kernel as `modules', you 226 - If you configured any of the parts of the kernel as `modules', you
232 will also have to do "make modules_install". 227 will also have to do "make modules_install".
233 228
229 - Verbose kernel compile/build output:
230
231 Normally the kernel build system runs in a fairly quiet mode (but not
232 totally silent). However, sometimes you or other kernel developers need
233 to see compile, link, or other commands exactly as they are executed.
234 For this, use "verbose" build mode. This is done by inserting
235 "V=1" in the "make" command. E.g.:
236
237 make V=1 all
238
239 To have the build system also tell the reason for the rebuild of each
240 target, use "V=2". The default is "V=0".
241
234 - Keep a backup kernel handy in case something goes wrong. This is 242 - Keep a backup kernel handy in case something goes wrong. This is
235 especially true for the development releases, since each new release 243 especially true for the development releases, since each new release
236 contains new code which has not been debugged. Make sure you keep a 244 contains new code which has not been debugged. Make sure you keep a