xref: /openbmc/linux/README (revision 6bef44b9)
1*6bef44b9SMauro Carvalho ChehabLinux kernel
2*6bef44b9SMauro Carvalho Chehab============
3*6bef44b9SMauro Carvalho Chehab
4*6bef44b9SMauro Carvalho ChehabThis file was moved to Documentation/admin-guide/README.rst
5*6bef44b9SMauro Carvalho Chehab
6*6bef44b9SMauro Carvalho ChehabPlease notice that there are several guides for kernel developers and users.
7*6bef44b9SMauro Carvalho ChehabThese guides can be rendered in a number of formats, like HTML and PDF.
8*6bef44b9SMauro Carvalho Chehab
9*6bef44b9SMauro Carvalho ChehabIn order to build the documentation, use ``make htmldocs`` or
10*6bef44b9SMauro Carvalho Chehab``make pdfdocs``.
11*6bef44b9SMauro Carvalho Chehab
12*6bef44b9SMauro Carvalho ChehabThere are various text files in the Documentation/ subdirectory,
13*6bef44b9SMauro Carvalho Chehabseveral of them using the Restructured Text markup notation.
14*6bef44b9SMauro Carvalho ChehabSee Documentation/00-INDEX for a list of what is contained in each file.
15*6bef44b9SMauro Carvalho Chehab
16*6bef44b9SMauro Carvalho ChehabPlease read the Documentation/process/changes.rst file, as it contains the
17*6bef44b9SMauro Carvalho Chehabrequirements for building and running the kernel, and information about
18*6bef44b9SMauro Carvalho Chehabthe problems which may result by upgrading your kernel.
19