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: 91+ 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 01/57] docs: trace: fix some Sphinx warnings Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 02/57] docs: acpi: convert text files to ReST Mauro Carvalho Chehab
2019-04-16 8:17 ` Rafael J. Wysocki
2019-04-16 9:54 ` Mauro Carvalho Chehab
2019-04-16 10:17 ` Rafael J. Wysocki
2019-04-16 14:55 ` Changbin Du
2019-04-22 13:31 ` Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 03/57] docs: aoe: " Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 04/57] docs: arm64: convert documentation to ReST format Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 05/57] docs: cdrom/cdrom-standard.tex: convert from LaTeX to ReST Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 06/57] docs: cdrom: convert remaining files " Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 07/57] docs: cgroup-v1: convert to ReST file format Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 08/57] docs: cgroup-v1/blkio-controller.rst: add a note about CFQ scheduler Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 09/57] docs: cpu-freq: convert files to ReST Mauro Carvalho Chehab
2019-04-16 8:21 ` Rafael J. Wysocki
2019-04-16 9:58 ` 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-16 2:55 ` [PATCH 11/57] docs: extcon: move it to acpi dir and convert it to ReST Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 12/57] docs: fault-injection: convert it to ReST format Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 13/57] docs: fb: convert documentation " Mauro Carvalho Chehab
2019-05-06 13:36 ` Bartlomiej Zolnierkiewicz
2019-04-16 2:55 ` [PATCH 14/57] docs: fpga: convert it to ReST Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 15/57] docs: gpio: " Mauro Carvalho Chehab
2019-04-23 10:52 ` Linus Walleij
2019-04-23 12:38 ` Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 16/57] docs: ide: convert it to ReST format Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 17/57] docs: infiniband: " Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 18/57] docs: kbuild: convert it to ReST output Mauro Carvalho Chehab
2019-04-18 9:25 ` Masahiro Yamada
2019-04-18 10:26 ` Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 19/57] docs: kdump: convert it to ReST Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 20/57] docs: livepatch: convert it to ReST format Mauro Carvalho Chehab
2019-04-16 8:43 ` Petr Mladek
2019-04-16 11:47 ` Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 21/57] docs: locking: convert docs " Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 22/57] docs: mic: convert it " Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 23/57] docs: netlabel: convert it to ReST Mauro Carvalho Chehab
2019-04-17 14:36 ` Paul Moore
2019-04-16 2:55 ` [PATCH 24/57] docs: pcmcia: convert it to ReST format Mauro Carvalho Chehab
2019-04-16 4:58 ` Dominik Brodowski
2019-04-16 2:55 ` [PATCH 25/57] docs: power: convert docs to ReST Mauro Carvalho Chehab
2019-04-16 7:20 ` Pavel Machek
2019-04-16 8:59 ` Rafael J. Wysocki
2019-04-16 10:41 ` Mauro Carvalho Chehab
2019-04-16 10:47 ` Rafael J. Wysocki
2019-04-16 2:55 ` [PATCH 26/57] docs: powerpc: " Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 27/57] docs: pps/pps.txt convert it to ReST and move to API book Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 28/57] docs: ptp.txt: convert to ReST and move to driver-api Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 29/57] docs: riscv: convert it to ReST format Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 30/57] docs: s390: Debugging390.txt: convert table to ascii artwork Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 31/57] docs: s390: convert text files to ReST format Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 32/57] s390: include/asm/debug.h add kerneldoc markups Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 33/57] docs: serial: convert it to ReST format Mauro Carvalho Chehab
2019-04-16 2:55 ` [PATCH 34/57] docs: target: " Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 35/57] docs: timers: convert documentation to ReST Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 36/57] docs: usb: convert documents " Mauro Carvalho Chehab
2019-04-16 6:12 ` Felipe Balbi
2019-04-16 11:43 ` Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 37/57] docs: watchdog: convert documents to ReST format Mauro Carvalho Chehab
2019-04-17 17:53 ` Guenter Roeck
2019-04-16 2:56 ` [PATCH 38/57] docs: x86: convert text files to ReST Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 39/57] docs: xilinx: convert eemi.txt " Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 40/57] docs: scheduler: convert files " Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 41/57] docs: EDID/HOWTO.txt: convert to ReST and move to kernel-API Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 42/57] docs: connector.txt: convert to ReST Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 43/57] docs: lcd-panel-cgram.txt convert it to ReST and move to admin-guide Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 44/57] docs: lp855x-driver.txt: convert to ReST and move to kernel-api Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 45/57] docs: m68k: convert it to ReST file format and add to arch bookset Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 46/57] docs: cma/debugfs.txt: convert to ReST and move to admin-guide/mm Mauro Carvalho Chehab
2019-04-16 5:21 ` Mike Rapoport
2019-04-16 11:35 ` Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 47/57] docs: console.txt: convert to ReST format Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 48/57] docs: pti_intel_mid.txt: convert to ReST Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 49/57] docs: early-userspace: convert docs " Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 50/57] docs: driver-model: convert it to ReST format Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 51/57] docs: arm: convert text files " Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 52/57] docs: memory-devices: convert ti-emif.txt " Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 53/57] docs: xen-tpmfront.txt: convert the file " Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 54/57] docs: bus-devices: ti-gpmc.txt: convert it to ReST Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 55/57] docs: nvmem: convert file to ReST format Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 56/57] docs: phy: convert samsung-usb2.txt " Mauro Carvalho Chehab
2019-04-16 2:56 ` [PATCH 57/57] docs: Prepare files to be renamed to *.rst 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