Commit c95940f2 authored by Nicolas Kaiser's avatar Nicolas Kaiser Committed by Linus Torvalds

Documentation: fix kbuild typos and wording

Fixed some typos and wording.
Signed-off-by: default avatarNicolas Kaiser <nikai@nikai.net>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent eb07e1b4
...@@ -40,15 +40,15 @@ Set the directory to look for the kernel source when building external ...@@ -40,15 +40,15 @@ Set the directory to look for the kernel source when building external
modules. modules.
The directory can be specified in several ways: The directory can be specified in several ways:
1) Use "M=..." on the command line 1) Use "M=..." on the command line
2) Environmnet variable KBUILD_EXTMOD 2) Environment variable KBUILD_EXTMOD
3) Environmnet variable SUBDIRS 3) Environment variable SUBDIRS
The possibilities are listed in the order they take precedence. The possibilities are listed in the order they take precedence.
Using "M=..." will always override the others. Using "M=..." will always override the others.
KBUILD_OUTPUT KBUILD_OUTPUT
-------------------------------------------------- --------------------------------------------------
Specify the output directory when building the kernel. Specify the output directory when building the kernel.
The output directory can also be specificed using "O=...". The output directory can also be specified using "O=...".
Setting "O=..." takes precedence over KBUILD_OUTPUT. Setting "O=..." takes precedence over KBUILD_OUTPUT.
ARCH ARCH
...@@ -90,7 +90,7 @@ The script will be called with the following arguments: ...@@ -90,7 +90,7 @@ The script will be called with the following arguments:
$3 - kernel map file $3 - kernel map file
$4 - default install path (use root directory if blank) $4 - default install path (use root directory if blank)
The implmentation of "make install" is architecture specific The implementation of "make install" is architecture specific
and it may differ from the above. and it may differ from the above.
INSTALLKERNEL is provided to enable the possibility to INSTALLKERNEL is provided to enable the possibility to
......
...@@ -285,12 +285,12 @@ more details, with real examples. ...@@ -285,12 +285,12 @@ more details, with real examples.
--- 3.7 Compilation flags --- 3.7 Compilation flags
ccflags-y, asflags-y and ldflags-y ccflags-y, asflags-y and ldflags-y
The three flags listed above apply only to the kbuild makefile where These three flags apply only to the kbuild makefile in which they
they are assigned (i.e., per-directory). They are used for all the are assigned. They are used for all the normal cc, as and ld
normal cc, as and ld invocation happening during a recursive build. invocations happening during a recursive build.
Note: Flags with the same behaviour were previously named: Note: Flags with the same behaviour were previously named:
EXTRA_CFLAGS, EXTRA_AFLAGS and EXTRA_LDFLAGS. They are still EXTRA_CFLAGS, EXTRA_AFLAGS and EXTRA_LDFLAGS.
supported but their use is deprecated. They are still supported but their usage is deprecated.
ccflags-y specifies options for compiling with $(CC). ccflags-y specifies options for compiling with $(CC).
...@@ -317,10 +317,10 @@ more details, with real examples. ...@@ -317,10 +317,10 @@ more details, with real examples.
subdir-ccflags-y, subdir-asflags-y subdir-ccflags-y, subdir-asflags-y
The two flags listed above are similar to ccflags-y and asflags-y. The two flags listed above are similar to ccflags-y and asflags-y.
The difference is that the subdir- variants affect the kbuild The difference is that the subdir- variants have effect for the kbuild
file where they are present and all subdirectories. Options specified file where they are present and all subdirectories.
using subdir-* are added to the commandline before the options Options specified using subdir-* are added to the commandline before
specified using the non-subdir variants. the options specified using the non-subdir variants.
Example: Example:
subdir-ccflags-y := -Werror subdir-ccflags-y := -Werror
...@@ -1174,14 +1174,14 @@ When kbuild executes, the following steps are followed (roughly): ...@@ -1174,14 +1174,14 @@ When kbuild executes, the following steps are followed (roughly):
=== 7 Kbuild syntax for exported headers === 7 Kbuild syntax for exported headers
The kernel include a set of headers that is exported to userspace. The kernel include a set of headers that is exported to userspace.
Many headers can be exported as-is but other headers requires a Many headers can be exported as-is but other headers require a
minimal pre-processing before they are ready for user-space. minimal pre-processing before they are ready for user-space.
The pre-processing does: The pre-processing does:
- drop kernel specific annotations - drop kernel specific annotations
- drop include of compiler.h - drop include of compiler.h
- drop all sections that is kernel internat (guarded by ifdef __KERNEL__) - drop all sections that are kernel internal (guarded by ifdef __KERNEL__)
Each relevant directory contain a file name "Kbuild" which specify the Each relevant directory contains a file name "Kbuild" which specifies the
headers to be exported. headers to be exported.
See subsequent chapter for the syntax of the Kbuild file. See subsequent chapter for the syntax of the Kbuild file.
......
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