[dm-devel] [PATCH 10/57] docs: device-mapper: convert it to ReST format

[Jonathan Corbet]

On Tue, 16 Apr 2019 11:48:59 -0400
Mike Snitzer <snitzer at 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