[mirror_ubuntu-zesty-kernel.git] / Documentation / kbuild / modules.txt


In this document you will find information about:
- how to build external modules
- how to make your module use kbuild infrastructure
- how kbuild will install a kernel
- how to install modules in a non-standard location

=== Table of Contents

	=== 1 Introduction
	=== 2 How to build external modules
	   --- 2.1 Building external modules
	   --- 2.2 Available targets
	   --- 2.3 Available options
	   --- 2.4 Preparing the kernel tree for module build
	=== 3. Example commands
	=== 4. Creating a kbuild file for an external module
	=== 5. Include files
	   --- 5.1 How to include files from the kernel include dir
	   --- 5.2 External modules using an include/ dir
	=== 6. Module installation
	   --- 6.1 INSTALL_MOD_PATH
	   --- 6.2 INSTALL_MOD_DIR
	=== 7. Module versioning
	=== 8. Tips & Tricks
	   --- 8.1 Testing for CONFIG_FOO_BAR


=== 1. Introduction

kbuild includes functionality for building modules both
within the kernel source tree and outside the kernel source tree.
The latter is usually referred to as external modules and is used
both during development and for modules that are not planned to be
included in the kernel tree.

What is covered within this file is mainly information to authors
of modules. The author of an external modules should supply
a makefile that hides most of the complexity so one only has to type
'make' to buld the module. A complete example will be present in
Commit	Line	Data
1da177e4 LT	1
	2	In this document you will find information about:
	3	- how to build external modules
	4	- how to make your module use kbuild infrastructure
	5	- how kbuild will install a kernel
	6	- how to install modules in a non-standard location
	7
	8	=== Table of Contents
	9
	10	=== 1 Introduction
	11	=== 2 How to build external modules
	12	--- 2.1 Building external modules
	13	--- 2.2 Available targets
	14	--- 2.3 Available options
	15	--- 2.4 Preparing the kernel tree for module build
	16	=== 3. Example commands
	17	=== 4. Creating a kbuild file for an external module
	18	=== 5. Include files
	19	--- 5.1 How to include files from the kernel include dir
	20	--- 5.2 External modules using an include/ dir
	21	=== 6. Module installation
	22	--- 6.1 INSTALL_MOD_PATH
	23	--- 6.2 INSTALL_MOD_DIR
	24	=== 7. Module versioning
	25	=== 8. Tips & Tricks
	26	--- 8.1 Testing for CONFIG_FOO_BAR
	27
	28
	29
	30	=== 1. Introduction
	31
	32	kbuild includes functionality for building modules both
	33	within the kernel source tree and outside the kernel source tree.
	34	The latter is usually referred to as external modules and is used
	35	both during development and for modules that are not planned to be
	36	included in the kernel tree.
	37
	38	What is covered within this file is mainly information to authors
	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
	41	'make' to buld the module. A complete example will be present in
	42