README: Improve documentation descriptions
authorMartin Kepplinger <martink@posteo.de>
Fri, 16 Mar 2018 15:57:07 +0000 (16:57 +0100)
committerJonathan Corbet <corbet@lwn.net>
Wed, 21 Mar 2018 15:00:39 +0000 (09:00 -0600)
"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>
README

diff --git a/README b/README
index b2ba4aaa3a71046653599aa0b3798b211a2c0d30..12b4674a483c29905be6fc7e55ec705f3826b7bc 100644 (file)
--- 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``.