linux - README

18 lines · 722 B

Linux kernel
============

This file was moved to Documentation/admin-guide/README.rst

Please notice that there are several guides for kernel developers and users.
These guides can be rendered in a number of formats, like HTML and PDF.

In order to build the documentation, use ``make htmldocs`` or
``make pdfdocs``.

There are various text files in the Documentation/ subdirectory,
several of them using the Restructured Text markup notation.
See Documentation/00-INDEX for a list of what is contained in each file.

Please read the Documentation/process/changes.rst file, as it contains the
requirements for building and running the kernel, and information about
the problems which may result by upgrading your kernel.

1	Linux kernel
2	============
3
4	This file was moved to Documentation/admin-guide/README.rst
5
6	Please notice that there are several guides for kernel developers and users.
7	These guides can be rendered in a number of formats, like HTML and PDF.
8
9	In order to build the documentation, use ``make htmldocs`` or
10	``make pdfdocs``.
11
12	There are various text files in the Documentation/ subdirectory,
13	several of them using the Restructured Text markup notation.
14	See Documentation/00-INDEX for a list of what is contained in each file.
15
16	Please read the Documentation/process/changes.rst file, as it contains the
17	requirements for building and running the kernel, and information about
18	the problems which may result by upgrading your kernel.