Commit ee598ace authored by Sam Ravnborg's avatar Sam Ravnborg

kbuild/doc: Delete obsolete documentation files

commands.txt
Content was not updated for a long time, and README includes the same info

random.txt
make help includes the same info (in compressed format)
parent 8745f368
00-INDEX
- this file: info on the kernel build process
commands.txt
- overview of kbuild commands
kconfig-language.txt
- specification of Config Language, the language in Kconfig files
random.txt
- description of generic config targets
makefiles.txt
- developer information for linux kernel makefiles
Overview of Kbuild Commands
24 January 1999
Michael Elizabeth Chastain, <mailto:mec@shout.net>
=== Introduction
Someday we'll get our arms around all this stuff and clean it up
a little! Meanwhile, this file describes the system as it is today.
=== Quick Start
If you are building a kernel for the first time, here are the commands
you need:
make config
make dep
make bzImage
Instead of 'make config', you can run 'make menuconfig' for a full-screen
text interface, or 'make xconfig' for an X interface using TCL/TK.
'make bzImage' will leave your new kernel image in arch/i386/boot/bzImage.
You can also use 'make bzdisk' or 'make bzlilo'.
See the lilo documentation for more information on how to use lilo.
You can also use the 'loadlin' program to boot Linux from MS-DOS.
Some computers won't work with 'make bzImage', either due to hardware
problems or very old versions of lilo or loadlin. If your kernel image
is small, you may use 'make zImage', 'make zdisk', or 'make zlilo'
on theses systems.
If you find a file name 'vmlinux' in the top directory of the source tree,
just ignore it. This is an intermediate file and you can't boot from it.
Other architectures: the information above is oriented towards the
i386. On other architectures, there are no 'bzImage' files; simply
use 'zImage' or 'vmlinux' as appropriate for your architecture.
Note: the difference between 'zImage' files and 'bzImage' files is that
'bzImage' uses a different layout and a different loading algorithm,
and thus has a larger capacity. Both files use gzip compression.
The 'bz' in 'bzImage' stands for 'big zImage', not for 'bzip'!
=== Top Level Makefile targets
Here are the targets available at the top level:
make config, make oldconfig, make menuconfig, make xconfig
Configure the Linux kernel. You must do this before almost
anything else.
config line-oriented interface
oldconfig line-oriented interface, re-uses old values
menuconfig curses-based full-screen interface
xconfig X window system interface
make checkconfig
This runs a little perl script that checks the source tree for
missing instances of #include <linux/config.h>. Someone needs to
do this occasionally, because the C preprocessor will silently give
bad results if these symbols haven't been included (it treats
undefined symbols in preprocessor directives as defined to 0).
Superfluous uses of #include <linux/config.h> are also reported,
but you can ignore these, because smart CONFIG_* dependencies
make them harmless.
You can run 'make checkconfig' without configuring the kernel.
Also, 'make checkconfig' does not modify any files.
make checkhelp
This runs another little perl script that checks the source tree
for options that are in Config.in files but are not documented
in scripts/Configure.help. Again, someone needs to do this
occasionally. If you are adding configuration options, it's
nice if you do it before you publish your patch!
You can run 'make checkhelp' without configuring the kernel.
Also, 'make checkhelp' does not modify any files.
make dep, make depend
'make dep' is a synonym for the long form, 'make depend'.
This command does two things. First, it computes dependency
information about which .o files depend on which .h files.
It records this information in a top-level file named .hdepend
and in one file per source directory named .depend.
Second, if you have CONFIG_MODVERSIONS enabled, 'make dep'
computes symbol version information for all of the files that
export symbols (note that both resident and modular files may
export symbols).
If you do not enable CONFIG_MODVERSIONS, you only have to run
'make dep' once, right after the first time you configure
the kernel. The .hdepend files and the .depend file are
independent of your configuration.
If you do enable CONFIG_MODVERSIONS, you must run 'make dep'
every time you change your configuration, because the module
symbol version information depends on the configuration.
[to be continued ...]
Code by Ghozlane Toumi <gtoumi@messel.emse.fr>, documentation by
Keith Owens <kaos@ocs.com.au>
In addition to the normal config targets you can make
randconfig random configuration.
allyes reply 'y' to all options, maximal kernel.
allno reply 'n' to all options, minimal kernel.
allmod build everything as modules where possible.
All random configurations will satisfy the config rules, that is, all
configurations should be valid. Any build errors indicate bugs in the
config dependency rules or in the Makefiles.
You can constrain the random configuration, e.g. you may want to force
the use of modules or the absence of /proc or cramfs must be a module.
If file .force_default exists then it is read to preset selected
values, all other values will be randomly selected, subject to the
config rules. The syntax of .force_default is:
CONFIG_foo=value
Force this value, for example CONFIG_MODULES=y, CONFIG_PROC_FS=n,
CONFIG_RAMFS=m.
# CONFIG_foo is not set
Equivalent to CONFIG_foo=n, supported because this is the format used
in .config. NOTE: The leading '#' is required.
# list CONFIG_foo val1,val2,val3
Pick a value for CONFIG_foo from the list. CONFIG_foo must be an int
or hex option. NOTE: The leading '#' is required.
# range CONFIG_foo min max
Pick a value for CONFIG_foo in the range min <=> max. CONFIG_foo
must be an int option. NOTE: The leading '#' is required.
If you have repeated settings of the same option in .force_default then
values take precedence over lists which take precedence over range.
Within each group the last setting for an option is used.
Answers "randomised" are bool(), tristate(), dep_tristate() and
choice(). Unless specified in .force_default, int, hex, and string
options use the default values from config.in.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment