From: Daniel Vetter <daniel.vetter@ffwll.ch>
To: LKML <linux-kernel@vger.kernel.org>
Cc: Daniel Vetter <daniel.vetter@ffwll.ch>,
Jonathan Corbet <corbet@lwn.net>,
linux-doc@vger.kernel.org, Christoph Hellwig <hch@infradead.org>,
Peter Zijlstra <peterz@infradead.org>,
Jani Nikula <jani.nikula@linux.intel.com>,
Mauro Carvalho Chehab <mchehab@s-opensource.com>,
Daniel Vetter <daniel.vetter@intel.com>
Subject: [PATCH] doc: Explain light-handed markup preference a bit better
Date: Mon, 28 Nov 2016 17:16:22 +0100 [thread overview]
Message-ID: <20161128161622.906-1-daniel.vetter@ffwll.ch> (raw)
We already had a super-short blurb, but worth extending it I think:
We're still pretty far away from anything like a consensus, but
there's clearly a lot of people who prefer an as-light as possible
approach to converting existing .txt files to .rst. Make sure this is
properly taken into account and clear.
Motivated by discussions with Peter and Christoph and others.
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: Christoph Hellwig <hch@infradead.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Jani Nikula <jani.nikula@linux.intel.com>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
---
Documentation/kernel-documentation.rst | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/Documentation/kernel-documentation.rst b/Documentation/kernel-documentation.rst
index 0dd17069bc0b..ceb17d428278 100644
--- a/Documentation/kernel-documentation.rst
+++ b/Documentation/kernel-documentation.rst
@@ -77,7 +77,16 @@ Specific guidelines for the kernel documentation
Here are some specific guidelines for the kernel documentation:
-* Please don't go overboard with reStructuredText markup. Keep it simple.
+* Please don't go overboard with reStructuredText markup. Keep it simple. A lot
+ of core kernel developers prefer plain text, with a big emphasis on plain. And
+ in the end if we have pretty generated docs which the subject experts don't
+ like to edit and keep up-to-date everyone loses.
+
+ Be especially considerate when converting existing .txt documentation. There's
+ a wide scale from annotating every little bit with in-line styles to only
+ touching up the bare minimum needed to integrate an existing file into the
+ larger documentation. Please align with the wishes of the maintainer to make
+ sure that documentations stays useful for everyone.
* Please stick to this order of heading adornments:
--
2.10.2
next reply other threads:[~2016-11-28 16:16 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-11-28 16:16 Daniel Vetter [this message]
2016-11-28 17:51 ` Mauro Carvalho Chehab
2016-11-29 9:23 Daniel Vetter
2016-11-29 10:28 ` Markus Heiser
2016-11-29 11:54 ` Mauro Carvalho Chehab
2016-11-29 10:38 ` Jani Nikula
2016-11-29 11:43 ` Mauro Carvalho Chehab
2016-11-29 15:08 ` Jani Nikula
2016-12-07 15:45 ` Daniel Vetter
2016-11-29 13:17 ` Daniel Vetter
2016-12-06 7:52 ` Peter Zijlstra
2016-12-07 15:45 ` Daniel Vetter
2016-12-07 15:42 Daniel Vetter
2016-12-07 19:39 ` Jonathan Corbet
2016-12-08 9:10 ` Mauro Carvalho Chehab
2016-12-08 22:06 ` Daniel Vetter
2016-12-12 17:47 ` Mauro Carvalho Chehab
2016-12-12 17:54 ` Jonathan Corbet
2016-12-14 13:46 Daniel Vetter
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=20161128161622.906-1-daniel.vetter@ffwll.ch \
--to=daniel.vetter@ffwll.ch \
--cc=corbet@lwn.net \
--cc=daniel.vetter@intel.com \
--cc=hch@infradead.org \
--cc=jani.nikula@linux.intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab@s-opensource.com \
--cc=peterz@infradead.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®