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