Skip to content

Commit

Permalink
README: Improve documentation descriptions
Browse files Browse the repository at this point in the history
"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>
  • Loading branch information
merge authored and Jonathan Corbet committed Mar 21, 2018
1 parent 7f5d465 commit 9f4a68e
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README
Original file line number Diff line number Diff line change
@@ -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``.
Expand Down

0 comments on commit 9f4a68e

Please sign in to comment.