Compile Linux kernel documentation as man Manual

Compile the Linux kernel documentation as a man manual.
For each Linux kernel and driver developer, the documentation directory provided by the kernel is undoubtedly a very useful reference and learning material. It is recommended to read more ~

Some kernel APIs may be used when we are writing a driver or modifying the kernel. We also want to see how to use them in the man manual like the libc API, without a doubt, finding the relevant function definition in the kernel source code is a method, but it is quite troublesome. You can install the kernel API as the man manual, and then you can easily run man XXX-kernel-API. The procedure is as follows (based on fc6 ):

(1) In the top-level directory of the kernel source, execute make installmandocs to install the man manual under/usr/local/man/man9.

Notes: Note: If you need other tools when executing make installmandocsProgram, You can use the yum tool for online installation. For example, in the case of make installmandocs, therefore, execute Yum install xmlto install the required tools and then execute make installmandocs.

Since then, it has been installed. The following section shows man copy_from_user.

Copy_from_user (9) user space memory access copy_from_user (9)

 

Name
Copy_from_user-copy a block of data from user space.

Synopsis
Unsigned long copy_from_user (void * To, const void _ User * from,
Unsigned long N );

Arguments
To Destination Address, in kernel space.

From Source Address, in user space.

N number of bytes to copy.

Context
User context only. This function may sleep.

Description
Copy data from user space to kernel space.

Returns number of bytes that cocould not be copied. on success, this will
Be zero.

If some data cocould not be copied, this function will pad the copied
Data to the requested Size Using Zero bytes.

 

Kernel hackers manual January 2008 copy_from_user (9)

This article from the csdn blog, reproduced please indicate the source: http://blog.csdn.net/bshawk/archive/2008/01/27/2068676.aspx