aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Kepplinger <martink@posteo.de>2018-03-16 16:57:07 +0100
committerJonathan Corbet <corbet@lwn.net>2018-03-21 09:00:39 -0600
commit9f4a68e416a5930a0f8024453a84afa25134c1a0 (patch)
tree410b5c6d9c8678008591bfc733c695939a094556
parent7f5d465f4ddc242709a01030313e80a8d94ccaaa (diff)
README: Improve documentation descriptions
"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>
-rw-r--r--README7
1 files changed, 3 insertions, 4 deletions
diff --git a/README b/README
index b2ba4aaa3a71..12b4674a483c 100644
--- a/README
+++ b/README
@@ -1,10 +1,9 @@
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.
+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
+Documentation/admin-guide/README.rst first.
In order to build the documentation, use ``make htmldocs`` or
``make pdfdocs``.

Privacy Policy