Minki/linux
1
0
Fork 1
mirror of https://github.com/torvalds/linux.git synced 2024-11-21 19:41:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

README: Improve documentation descriptions

Browse Source 
"This file" indeed was moved once, but at some point "this file", the
top-level README, becomes a file in itself. Now that time has come :)

Let's describe how things are, and suggest reading "this file" first,
"this file" simply being a the admin-guide README file, not a file that
was once moved.

Signed-off-by: Martin Kepplinger <martink@posteo.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Martin Kepplinger 2018-03-16 16:57:07 +01:00 committed by Jonathan Corbet
parent 7f5d465f4d
commit 9f4a68e416
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README
View File

@ -1,10 +1,9 @@
Linux kernel Linux kernel
============ ============
This file was moved to Documentation/admin-guide/README.rst There are several guides for kernel developers and users. These guides can
be rendered in a number of formats, like HTML and PDF. Please read
Please notice that there are several guides for kernel developers and users. Documentation/admin-guide/README.rst first.
These guides can be rendered in a number of formats, like HTML and PDF.
In order to build the documentation, use ``make htmldocs`` or In order to build the documentation, use ``make htmldocs`` or
``make pdfdocs``. ``make pdfdocs``.