From: Jonathan Corbet <corbet@lwn.net>
To: Mike Snitzer <snitzer@redhat.com>
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
linux-kernel@vger.kernel.org, Alasdair Kergon <agk@redhat.com>,
dm-devel@redhat.com
Subject: Re: [PATCH 10/57] docs: device-mapper: convert it to ReST format
Date: Tue, 16 Apr 2019 11:27:23 -0600 [thread overview]
Message-ID: <20190416112723.66b4bd4a@lwn.net> (raw)
In-Reply-To: <20190416154858.GB22497@redhat.com>
On Tue, 16 Apr 2019 11:48:59 -0400
Mike Snitzer <snitzer@redhat.com> wrote:
> Think the last piece I'm missing is: how does one edit a .rst document
> without having to know to sprinkle syntactic sugar around? Does emacs
> have a ReST mode? If not what client interface are people using to
> properly change these documents?
There is an RST mode for Emacs, yes. But you likely don't really need
it. RST is a simple format and, in general, we try to keep the markup to
a minimum so that the plain-text files remain as readable as possible.
Most of our documents are 99% RST before anybody gets around to formally
converting them.
> (apologies if this is all spelled out nicely in Documentation/
> somewhere, but please help this man learn to fish).
Basics in Documentation/doc-guide (or
https://www.kernel.org/doc/html/latest/doc-guide/index.html). There's
also some history and overview in:
https://lwn.net/Articles/692704/
https://lwn.net/Articles/692705/
Thanks,
jon
next prev parent reply other threads:[~2019-04-16 17:27 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-16 2:55 [PATCH 00/57] Convert files to ReST Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 10/57] docs: device-mapper: convert it to ReST format Mauro Carvalho Chehab
2019-04-16 13:28 ` Mike Snitzer
2019-04-16 14:00 ` Jonathan Corbet
2019-04-16 14:33 ` Mauro Carvalho Chehab
2019-04-16 15:48 ` Mike Snitzer
2019-04-16 17:27 ` Jonathan Corbet [this message]
2019-04-16 18:14 ` Mauro Carvalho Chehab
2019-04-18 12:42 ` Avoiding merge conflicts while adding new docs - Was: Re: [PATCH 00/57] Convert files to ReST Mauro Carvalho Chehab
2019-04-19 22:10 ` Jonathan Corbet
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=20190416112723.66b4bd4a@lwn.net \
--to=corbet@lwn.net \
--cc=agk@redhat.com \
--cc=dm-devel@redhat.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+samsung@kernel.org \
--cc=mchehab@infradead.org \
--cc=snitzer@redhat.com \
/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