From: Martin Kepplinger <martink@posteo.de>
To: corbet@lwn.net, sunny@sunbase.org
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Martin Kepplinger <martink@posteo.de>
Subject: [PATCH 1/2] README: revise the top level readme texts
Date: Wed, 12 Jul 2017 10:07:44 +0200 [thread overview]
Message-ID: <20170712080745.26338-1-martink@posteo.de> (raw)
This improves the top level README situation a little: Instead of starting
with historical information like "This file was moved to..." we add a short
introductory description and point the reader to the documention in a direct
way, avoiding phrases like "Please notice that there are...".
Signed-off-by: Martin Kepplinger <martink@posteo.de>
---
README | 26 ++++++++++++++++++--------
1 file changed, 18 insertions(+), 8 deletions(-)
diff --git a/README b/README
index b2ba4aaa3a71..b281213e7c6f 100644
--- a/README
+++ b/README
@@ -1,17 +1,27 @@
Linux kernel
============
-This file was moved to Documentation/admin-guide/README.rst
+Linux is a computer operating system kernel first released by Linus Torvalds
+in September of 1991. It runs on a wide variety of hardware architectures and
+has all expected features like multitasking, memory management, multistack
+networking and so on.
-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.
+Device drivers are an integral part too, supporting the use of countless
+devices. Documentation/process/howto.rst describes how to include a new one.
-In order to build the documentation, use ``make htmldocs`` or
-``make pdfdocs``.
+Documentation
+-------------
-There are various text files in the Documentation/ subdirectory,
-several of them using the Restructured Text markup notation.
-See Documentation/00-INDEX for a list of what is contained in each file.
+Linux is documented in the Documentation/ subdirectory. Several of the text
+files use the Restructured Text markup notation.
+
+Documentation/admin-guide/README.rst may be what you are looking for and
+Documentation/00-INDEX has a list of what is contained in each file.
+
+The included guides for kernel developers and users can be rendered in a number
+of formats, like HTML and PDF.
+
+In order to build the documentation, use ``make htmldocs`` or ``make pdfdocs``.
Please read the Documentation/process/changes.rst file, as it contains the
requirements for building and running the kernel, and information about
--
2.11.0
next reply other threads:[~2017-07-12 8:08 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-07-12 8:07 Martin Kepplinger [this message]
2017-07-12 8:07 ` [PATCH 2/2] Documentation: admin-guide: remove redundant first paragraph of README.rst Martin Kepplinger
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20170712080745.26338-1-martink@posteo.de \
--to=martink@posteo.de \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=sunny@sunbase.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®