| Mauro Carvalho Chehab | 6bef44b | 2016-10-18 10:46:38 -0200 | [diff] [blame] | 1 | Linux kernel |
| 2 | ============ |
| 3 | |
| Martin Kepplinger | 9f4a68e | 2018-03-16 16:57:07 +0100 | [diff] [blame] | 4 | There are several guides for kernel developers and users. These guides can |
| 5 | be rendered in a number of formats, like HTML and PDF. Please read |
| 6 | Documentation/admin-guide/README.rst first. |
| Mauro Carvalho Chehab | 6bef44b | 2016-10-18 10:46:38 -0200 | [diff] [blame] | 7 | |
| 8 | In order to build the documentation, use ``make htmldocs`` or |
| Jonathan Corbet | 4b290af | 2018-03-21 09:02:53 -0600 | [diff] [blame^] | 9 | ``make pdfdocs``. The formatted documentation can also be read online at: |
| 10 | |
| 11 | https://www.kernel.org/doc/html/latest/ |
| Mauro Carvalho Chehab | 6bef44b | 2016-10-18 10:46:38 -0200 | [diff] [blame] | 12 | |
| 13 | There are various text files in the Documentation/ subdirectory, |
| 14 | several of them using the Restructured Text markup notation. |
| 15 | See Documentation/00-INDEX for a list of what is contained in each file. |
| 16 | |
| 17 | Please read the Documentation/process/changes.rst file, as it contains the |
| 18 | requirements for building and running the kernel, and information about |
| 19 | the problems which may result by upgrading your kernel. |