blob: fd903645e6de0628ed3274423355426ec0347bab [file] [log] [blame]
Mauro Carvalho Chehab6bef44b2016-10-18 10:46:38 -02001Linux kernel
2============
3
Martin Kepplinger9f4a68e2018-03-16 16:57:07 +01004There are several guides for kernel developers and users. These guides can
5be rendered in a number of formats, like HTML and PDF. Please read
6Documentation/admin-guide/README.rst first.
Mauro Carvalho Chehab6bef44b2016-10-18 10:46:38 -02007
8In order to build the documentation, use ``make htmldocs`` or
Jonathan Corbet4b290af2018-03-21 09:02:53 -06009``make pdfdocs``. The formatted documentation can also be read online at:
10
11 https://www.kernel.org/doc/html/latest/
Mauro Carvalho Chehab6bef44b2016-10-18 10:46:38 -020012
13There are various text files in the Documentation/ subdirectory,
Maki Hatanobf4401f2024-03-13 18:01:07 +080014several of them using the reStructuredText markup notation.
Mauro Carvalho Chehab6bef44b2016-10-18 10:46:38 -020015
16Please read the Documentation/process/changes.rst file, as it contains the
17requirements for building and running the kernel, and information about
18the problems which may result by upgrading your kernel.