From: Daniel Vetter <daniel@ffwll.ch>
To: LKML <linux-kernel@vger.kernel.org>,
Peter Zijlstra <peterz@infradead.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: Re: [PATCH] doc: Explain light-handed markup preference a bit better
Date: Tue, 29 Nov 2016 14:17:52 +0100 [thread overview]
Message-ID: <20161129131752.63443vbvoudxe6sy@phenom.ffwll.local> (raw)
In-Reply-To: <20161129092314.351-1-daniel.vetter@ffwll.ch>
Hi Peter,
On Tue, Nov 29, 2016 at 10:23:14AM +0100, Daniel Vetter wrote:
> 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.
>
> v2:
> - Mention that existing headings should be kept when converting
> existing .txt files (Mauro).
> - Explain that we prefer :: for quoting code, it's easier on the
> eyes (Mauro).
> - Explain that blindly converting outdated docs is harmful. Motived
> by comments Peter did in our discussion.
>
> 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>
Since this was motivated by a discussion you've (re)started, does this
sufficiently address your concerns for conversion from plain text .txt to
plain text .rst of existing documents? Anything you'd want to see changed?
Thanks, Daniel
> ---
> Documentation/kernel-documentation.rst | 44 ++++++++++++++++++++++++++++++++--
> 1 file changed, 42 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/kernel-documentation.rst b/Documentation/kernel-documentation.rst
> index 0dd17069bc0b..d04cecdb498d 100644
> --- a/Documentation/kernel-documentation.rst
> +++ b/Documentation/kernel-documentation.rst
> @@ -77,9 +77,27 @@ 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. 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.
>
> -* Please stick to this order of heading adornments:
> + Be especially considerate when converting existing 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.
> +
> +* Don't just blindly convert documents, also carefully review them and fix up
> + any issues in the text itself. Updated docs might trick readers into believing
> + they're accurately reflecting current best practice, which would be rather
> + harmful if the text itself is entirely outdated.
> +
> +* When converting existing documents, please try to retain the existing heading
> + styles as much as possible. Sphinx accept almost anything, as long as it's
> + consistent and headings all start in column 1.
> +
> + For new documents please stick to this order of heading adornments:
>
> 1. ``=`` with overline for document title::
>
> @@ -136,6 +154,28 @@ changed to ``VIDIOC_LOG_STATUS`` and the function can now referenced by:
> :c:func:`VIDIOC_LOG_STATUS`
>
>
> +For inserting code examples and use-cases use the simple fixed-width quoting
> +style ``::`` which can either be on a line of it's own, or at the end of a
> +preceeding paragraph. If there's no space before the double-colon it will be
> +converted to a normal ``:``, which makes the overall text flow fairly reasonable
> +
> +.. code-block:: rst
> +
> + Some text explaing what you need to do::
> +
> + code_example()
> +
> + More text explaining the next step::
> +
> + if (condition)
> + more_function_calls();
> +
> +
> +Sphinx also supports ``.. code-block::`` annotations, which also allow you to
> +specify the language used for hightlight. But that should only be used when
> +really necessary.
> +
> +
> list tables
> -----------
>
> --
> 2.10.2
>
--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
next prev parent reply other threads:[~2016-11-29 13:17 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-11-29 9:23 [PATCH] doc: Explain light-handed markup preference a bit better 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 [this message]
2016-12-06 7:52 ` Peter Zijlstra
2016-12-07 15:45 ` Daniel Vetter
-- strict thread matches above, loose matches on Subject: below --
2016-12-14 13:46 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-11-28 16:16 Daniel Vetter
2016-11-28 17:51 ` Mauro Carvalho Chehab
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=20161129131752.63443vbvoudxe6sy@phenom.ffwll.local \
--to=daniel@ffwll.ch \
--cc=corbet@lwn.net \
--cc=daniel.vetter@ffwll.ch \
--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;
as well as URLs for NNTP newsgroup(s).