* [PATCH] README: Improve documentation descriptions
@ 2018-03-16 15:57 Martin Kepplinger
2018-03-21 15:02 ` Jonathan Corbet
0 siblings, 1 reply; 2+ messages in thread
From: Martin Kepplinger @ 2018-03-16 15:57 UTC (permalink / raw)
To: corbet; +Cc: linux-doc, linux-kernel, Martin Kepplinger
"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>
---
That's at least my opinion :)
thanks
martin
README | 7 +++----
1 file 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``.
--
2.14.2
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] README: Improve documentation descriptions
2018-03-16 15:57 [PATCH] README: Improve documentation descriptions Martin Kepplinger
@ 2018-03-21 15:02 ` Jonathan Corbet
0 siblings, 0 replies; 2+ messages in thread
From: Jonathan Corbet @ 2018-03-21 15:02 UTC (permalink / raw)
To: Martin Kepplinger; +Cc: linux-doc, linux-kernel
On Fri, 16 Mar 2018 16:57:07 +0100
Martin Kepplinger <martink@posteo.de> wrote:
> "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.
OK, sure, applied.
Maybe I'll tack on something pointing to
https://www.kernel.org/doc/html/latest/ as well.
Thanks,
jon
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2018-03-21 15:02 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-03-16 15:57 [PATCH] README: Improve documentation descriptions Martin Kepplinger
2018-03-21 15:02 ` Jonathan Corbet
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).