xref: /OK3568_Linux_fs/kernel/README (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593SmuzhiyunLinux kernel
2*4882a593Smuzhiyun============
3*4882a593Smuzhiyun
4*4882a593SmuzhiyunThere are several guides for kernel developers and users. These guides can
5*4882a593Smuzhiyunbe rendered in a number of formats, like HTML and PDF. Please read
6*4882a593SmuzhiyunDocumentation/admin-guide/README.rst first.
7*4882a593Smuzhiyun
8*4882a593SmuzhiyunIn order to build the documentation, use ``make htmldocs`` or
9*4882a593Smuzhiyun``make pdfdocs``.  The formatted documentation can also be read online at:
10*4882a593Smuzhiyun
11*4882a593Smuzhiyun    https://www.kernel.org/doc/html/latest/
12*4882a593Smuzhiyun
13*4882a593SmuzhiyunThere are various text files in the Documentation/ subdirectory,
14*4882a593Smuzhiyunseveral of them using the Restructured Text markup notation.
15*4882a593Smuzhiyun
16*4882a593SmuzhiyunPlease read the Documentation/process/changes.rst file, as it contains the
17*4882a593Smuzhiyunrequirements for building and running the kernel, and information about
18*4882a593Smuzhiyunthe problems which may result by upgrading your kernel.
19