diff options
| author | Brian Strand <bstrand@switchmanagement.com> | 2005-11-21 20:23:08 -0500 |
|---|---|---|
| committer | Sam Ravnborg <sam@mars.ravnborg.org> | 2005-12-16 17:15:41 -0500 |
| commit | 98a1e444111c9fd3f7a2b55225f7febf4209c020 (patch) | |
| tree | 649e7db9746ada555fe2a717234aada8b0dbbb81 | |
| parent | cb1a7b4df7e2ffc7c97891e8f350ce5db50df3b9 (diff) | |
kbuild: patch to Documentation/kbuild/modules.txt
First off, thanks for the kbuild docs, they are very useful! Second,
I've attached a patch to modules.txt (from 2.6.14.2) with a "compile"
fix to a Makefile example, and some trivial spelling/grammar nits.
Please let me know if you want the patch in some other format (eg not
MIME), or if I should go bother someone else about it.
Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
| -rw-r--r-- | Documentation/kbuild/modules.txt | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/Documentation/kbuild/modules.txt b/Documentation/kbuild/modules.txt index c91caf7eb303..1c0db652b366 100644 --- a/Documentation/kbuild/modules.txt +++ b/Documentation/kbuild/modules.txt | |||
| @@ -38,7 +38,7 @@ included in the kernel tree. | |||
| 38 | What is covered within this file is mainly information to authors | 38 | What is covered within this file is mainly information to authors |
| 39 | of modules. The author of an external modules should supply | 39 | of modules. The author of an external modules should supply |
| 40 | a makefile that hides most of the complexity so one only has to type | 40 | a makefile that hides most of the complexity so one only has to type |
| 41 | 'make' to buld the module. A complete example will be present in | 41 | 'make' to build the module. A complete example will be present in |
| 42 | chapter ¤. Creating a kbuild file for an external module". | 42 | chapter ¤. Creating a kbuild file for an external module". |
| 43 | 43 | ||
| 44 | 44 | ||
| @@ -69,7 +69,7 @@ when building an external module. | |||
| 69 | 69 | ||
| 70 | --- 2.2 Available targets | 70 | --- 2.2 Available targets |
| 71 | 71 | ||
| 72 | $KDIR refers to path to kernel source top-level directory | 72 | $KDIR refers to the path to the kernel source top-level directory |
| 73 | 73 | ||
| 74 | make -C $KDIR M=`pwd` | 74 | make -C $KDIR M=`pwd` |
| 75 | Will build the module(s) located in current directory. | 75 | Will build the module(s) located in current directory. |
| @@ -87,11 +87,11 @@ when building an external module. | |||
| 87 | make -C $KDIR M=$PWD modules_install | 87 | make -C $KDIR M=$PWD modules_install |
| 88 | Install the external module(s). | 88 | Install the external module(s). |
| 89 | Installation default is in /lib/modules/<kernel-version>/extra, | 89 | Installation default is in /lib/modules/<kernel-version>/extra, |
| 90 | but may be prefixed with INSTALL_MOD_PATH - see separate chater. | 90 | but may be prefixed with INSTALL_MOD_PATH - see separate chapter. |
| 91 | 91 | ||
| 92 | make -C $KDIR M=$PWD clean | 92 | make -C $KDIR M=$PWD clean |
| 93 | Remove all generated files for the module - the kernel | 93 | Remove all generated files for the module - the kernel |
| 94 | source directory is not moddified. | 94 | source directory is not modified. |
| 95 | 95 | ||
| 96 | make -C $KDIR M=`pwd` help | 96 | make -C $KDIR M=`pwd` help |
| 97 | help will list the available target when building external | 97 | help will list the available target when building external |
| @@ -99,7 +99,7 @@ when building an external module. | |||
| 99 | 99 | ||
| 100 | --- 2.3 Available options: | 100 | --- 2.3 Available options: |
| 101 | 101 | ||
| 102 | $KDIR refer to path to kernel src | 102 | $KDIR refers to the path to the kernel source top-level directory |
| 103 | 103 | ||
| 104 | make -C $KDIR | 104 | make -C $KDIR |
| 105 | Used to specify where to find the kernel source. | 105 | Used to specify where to find the kernel source. |
| @@ -206,11 +206,11 @@ following files: | |||
| 206 | 206 | ||
| 207 | KERNELDIR := /lib/modules/`uname -r`/build | 207 | KERNELDIR := /lib/modules/`uname -r`/build |
| 208 | all:: | 208 | all:: |
| 209 | $(MAKE) -C $KERNELDIR M=`pwd` $@ | 209 | $(MAKE) -C $(KERNELDIR) M=`pwd` $@ |
| 210 | 210 | ||
| 211 | # Module specific targets | 211 | # Module specific targets |
| 212 | genbin: | 212 | genbin: |
| 213 | echo "X" > 8123_bini.o_shipped | 213 | echo "X" > 8123_bin.o_shipped |
| 214 | 214 | ||
| 215 | endif | 215 | endif |
| 216 | 216 | ||
| @@ -341,13 +341,13 @@ directory and therefore needs to deal with this in their kbuild file. | |||
| 341 | EXTRA_CFLAGS := -Iinclude | 341 | EXTRA_CFLAGS := -Iinclude |
| 342 | 8123-y := 8123_if.o 8123_pci.o 8123_bin.o | 342 | 8123-y := 8123_if.o 8123_pci.o 8123_bin.o |
| 343 | 343 | ||
| 344 | Note that in the assingment there is no space between -I and the path. | 344 | Note that in the assignment there is no space between -I and the path. |
| 345 | This is a kbuild limitation and no space must be present. | 345 | This is a kbuild limitation: there must be no space present. |
| 346 | 346 | ||
| 347 | 347 | ||
| 348 | === 6. Module installation | 348 | === 6. Module installation |
| 349 | 349 | ||
| 350 | Modules which are included in the kernel is installed in the directory: | 350 | Modules which are included in the kernel are installed in the directory: |
| 351 | 351 | ||
| 352 | /lib/modules/$(KERNELRELEASE)/kernel | 352 | /lib/modules/$(KERNELRELEASE)/kernel |
| 353 | 353 | ||
| @@ -365,7 +365,7 @@ External modules are installed in the directory: | |||
| 365 | => Install dir: /frodo/lib/modules/$(KERNELRELEASE)/kernel | 365 | => Install dir: /frodo/lib/modules/$(KERNELRELEASE)/kernel |
| 366 | 366 | ||
| 367 | INSTALL_MOD_PATH may be set as an ordinary shell variable or as in the | 367 | INSTALL_MOD_PATH may be set as an ordinary shell variable or as in the |
| 368 | example above be specified on the commandline when calling make. | 368 | example above be specified on the command line when calling make. |
| 369 | INSTALL_MOD_PATH has effect both when installing modules included in | 369 | INSTALL_MOD_PATH has effect both when installing modules included in |
| 370 | the kernel as well as when installing external modules. | 370 | the kernel as well as when installing external modules. |
| 371 | 371 | ||
| @@ -384,7 +384,7 @@ External modules are installed in the directory: | |||
| 384 | 384 | ||
| 385 | === 7. Module versioning | 385 | === 7. Module versioning |
| 386 | 386 | ||
| 387 | Module versioning are enabled by the CONFIG_MODVERSIONS tag. | 387 | Module versioning is enabled by the CONFIG_MODVERSIONS tag. |
| 388 | 388 | ||
| 389 | Module versioning is used as a simple ABI consistency check. The Module | 389 | Module versioning is used as a simple ABI consistency check. The Module |
| 390 | versioning creates a CRC value of the full prototype for an exported symbol and | 390 | versioning creates a CRC value of the full prototype for an exported symbol and |
