kbuild: make*config usage doc.
Subsystems (2)
PATCH 1/1 kbuild: make*config usage doc.
Is this useful for anyone?
Is anything happening with mini.config or a replacement for it?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
From: Randy Dunlap <[email protected]>
Create a kconfig user assistance guide, with a few tips and hints about using menuconfig, xconfig, and gconfig.
Mostly contains user interface and search topics, along with mini.config/custom.config usage.
--- Documentation/kbuild/00-INDEX | 2 Documentation/kbuild/make-configs.txt | 167 ++++++++++++++++++++++++++++++++++ README | 17 +-- 3 files changed, 175 insertions(+), 11 deletions(-)
Documentation/kbuild/00-INDEX +2 -0
@@ -4,5 +4,7 @@ kconfig-language.txt - specification of Config Language, the language in Kconfig files makefiles.txt - developer information for linux kernel makefiles +make-configs.txt + - usage help for make *config modules.txt - how to build modules and to install them
Documentation/kbuild/make-configs.txt new file +167 -0
167 lines not on this page · raw message
README +6 -11
@@ -50,9 +50,9 @@ DOCUMENTATION: - The Documentation/DocBook/ subdirectory contains several guides for kernel developers and users. These guides can be rendered in a - number of formats: PostScript (.ps), PDF, and HTML, among others. - After installation, "make psdocs", "make pdfdocs", or "make htmldocs" - will render the documentation in the requested format. + number of formats: PostScript (.ps), PDF, HTML, & man-pages, among others. + After installation, "make psdocs", "make pdfdocs", "make htmldocs", + or "make mandocs" will render the documentation in the requested format. INSTALLING the kernel:
@@ -183,14 +183,9 @@ CONFIGURING the kernel: "make randconfig" Create a ./.config file by setting symbol values to random values. - The allyesconfig/allmodconfig/allnoconfig/randconfig variants can - also use the environment variable KCONFIG_ALLCONFIG to specify a - filename that contains config options that the user requires to be - set to a specific value. If KCONFIG_ALLCONFIG=filename is not used, - "make *config" checks for a file named "all{yes/mod/no/random}.config" - for symbol values that are to be forced. If this file is not found, - it checks for a file named "all.config" to contain forced values. - + You can find more information on using the Linux kernel config tools + in Documentation/kbuild/make-configs.txt. + NOTES on "make config": - having unnecessary drivers will make the kernel bigger, and can under some circumstances lead to problems: probing for a
---
Quoted 1 line · Randy Dunlap
Is this useful for anyone?
It's quite nice.
Quoted 1 line
Is anything happening with mini.config or a replacement for it?
Sorry, didn't know anybody else was interested.
I'm working on a patch to make the actual C code (probably scripts/kconfig/confdata.c:conf_write()) to spit out a miniconfig without the nasty shell script that takes forever to run. That's the big missing piece, the rest I already submitted two different patches to the list for. (Well, I should also tweak the makefile dependencies a bit to automatically regenerate a missing or older .config from a mini.config if it exists, but that's a later patch.)
I also owe Andrew Morton a better explanation of miniconfig. When I bumped into him at OLS he asked for a better explanation, but ever since I got back real life has pushed this off the back burner and into the refrigerator...
I'll try to scrape up some time this week to work on this.
(Oh, as long as Sam's cc'd: my todo item for this says "start from the klibc code", but klibc hasn't got the menuconfig infrastructure. I assume that discussion was just about Kbuild and not menuconfig? I'm still interested in using Kbuild for toybox, did you do any more work on this or is kbuild 1.4 still the best starting point?)
Quoted 9 lines
Documentation/kbuild/make-configs.txt new file +9
-0+KCONFIG_ALLCONFIG +-------------------------------------------------- +(partially based on lkml email from/by Rob Landley, re: miniconfig) +-------------------------------------------------- +The allyesconfig/allmodconfig/allnoconfig/randconfig variants can +also use the environment variable KCONFIG_ALLCONFIG as a flag or a +filename that contains config symbols that the user requires to be +set to a specific value. If KCONFIG_ALLCONFIG is used without a +filename, "make *config" checks for a file named
Documentation/kbuild/make-configs.txt line 99
Quoted 10 lines
Documentation/kbuild/make-configs.txt new file +10
-0+"all{yes/mod/no/random}.config" (corresponding to the *config command +that was used) for symbol values that are to be forced. If this file +is not found, it checks for a file named "all.config" to contain forced +values. + +This enables you to create "miniature" config (miniconfig) or custom +config files containing just the config symbols that you are interested +in. Then the kernel config system generates the full .config file, +including dependencies of your miniconfig file, based on the miniconfig +file.
I'd keep just that bit, and then refer to the miniconfig documentation when it goes in. Right now it doesn't tell you how to make a miniconfig, and the miniconfig patch adds an easier UI for using them anyway.
Lemme go poke at that now...
Rob
Signature · 2 lines
"Perfection is reached, not when there is no longer anything to add, but when there is no longer anything to take away." - Antoine de Saint-Exupery