Skip to content

Commit

Permalink
Documentation: fix kbuild typos and wording
Browse files Browse the repository at this point in the history
Fixed some typos and wording.

Signed-off-by: Nicolas Kaiser <[email protected]>
Signed-off-by: Linus Torvalds <[email protected]>
  • Loading branch information
nikai3d authored and torvalds committed Aug 5, 2010
1 parent eb07e1b commit c95940f
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 16 deletions.
8 changes: 4 additions & 4 deletions Documentation/kbuild/kbuild.txt
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,15 @@ Set the directory to look for the kernel source when building external
modules.
The directory can be specified in several ways:
1) Use "M=..." on the command line
2) Environmnet variable KBUILD_EXTMOD
3) Environmnet variable SUBDIRS
2) Environment variable KBUILD_EXTMOD
3) Environment variable SUBDIRS
The possibilities are listed in the order they take precedence.
Using "M=..." will always override the others.

KBUILD_OUTPUT
--------------------------------------------------
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.

ARCH
Expand Down Expand Up @@ -90,7 +90,7 @@ The script will be called with the following arguments:
$3 - kernel map file
$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.

INSTALLKERNEL is provided to enable the possibility to
Expand Down
24 changes: 12 additions & 12 deletions Documentation/kbuild/makefiles.txt
Original file line number Diff line number Diff line change
Expand Up @@ -285,12 +285,12 @@ more details, with real examples.
--- 3.7 Compilation flags

ccflags-y, asflags-y and ldflags-y
The three flags listed above apply only to the kbuild makefile where
they are assigned (i.e., per-directory). They are used for all the
normal cc, as and ld invocation happening during a recursive build.
These three flags apply only to the kbuild makefile in which they
are assigned. They are used for all the normal cc, as and ld
invocations happening during a recursive build.
Note: Flags with the same behaviour were previously named:
EXTRA_CFLAGS, EXTRA_AFLAGS and EXTRA_LDFLAGS. They are still
supported but their use is deprecated.
EXTRA_CFLAGS, EXTRA_AFLAGS and EXTRA_LDFLAGS.
They are still supported but their usage is deprecated.

ccflags-y specifies options for compiling with $(CC).

Expand All @@ -317,10 +317,10 @@ more details, with real examples.

subdir-ccflags-y, subdir-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
file where they are present and all subdirectories. Options specified
using subdir-* are added to the commandline before the options
specified using the non-subdir variants.
The difference is that the subdir- variants have effect for the kbuild
file where they are present and all subdirectories.
Options specified using subdir-* are added to the commandline before
the options specified using the non-subdir variants.

Example:
subdir-ccflags-y := -Werror
Expand Down Expand Up @@ -1174,14 +1174,14 @@ When kbuild executes, the following steps are followed (roughly):
=== 7 Kbuild syntax for exported headers

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.
The pre-processing does:
- drop kernel specific annotations
- 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.
See subsequent chapter for the syntax of the Kbuild file.

Expand Down

0 comments on commit c95940f

Please sign in to comment.