xref: /linux/README (revision 79790b6818e96c58fe2bffee1b418c16e64e7b80)
16bef44b9SMauro Carvalho ChehabLinux kernel
26bef44b9SMauro Carvalho Chehab============
36bef44b9SMauro Carvalho Chehab
49f4a68e4SMartin KepplingerThere are several guides for kernel developers and users. These guides can
59f4a68e4SMartin Kepplingerbe rendered in a number of formats, like HTML and PDF. Please read
69f4a68e4SMartin KepplingerDocumentation/admin-guide/README.rst first.
76bef44b9SMauro Carvalho Chehab
86bef44b9SMauro Carvalho ChehabIn order to build the documentation, use ``make htmldocs`` or
94b290af0SJonathan Corbet``make pdfdocs``.  The formatted documentation can also be read online at:
104b290af0SJonathan Corbet
114b290af0SJonathan Corbet    https://www.kernel.org/doc/html/latest/
126bef44b9SMauro Carvalho Chehab
136bef44b9SMauro Carvalho ChehabThere are various text files in the Documentation/ subdirectory,
14*bf4401f3SMaki Hatanoseveral of them using the reStructuredText markup notation.
156bef44b9SMauro Carvalho Chehab
166bef44b9SMauro Carvalho ChehabPlease read the Documentation/process/changes.rst file, as it contains the
176bef44b9SMauro Carvalho Chehabrequirements for building and running the kernel, and information about
186bef44b9SMauro Carvalho Chehabthe problems which may result by upgrading your kernel.
19