From: Kees Cook <keescook@google.com>
To: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
LKML <linux-kernel@vger.kernel.org>,
Jonathan Corbet <corbet@lwn.net>,
David Woodhouse <dwmw2@infradead.org>,
Brian Norris <computersforpeace@gmail.com>,
Boris Brezillon <boris.brezillon@free-electrons.com>,
Marek Vasut <marek.vasut@gmail.com>,
Richard Weinberger <richard@nod.at>,
Cyrille Pitchen <cyrille.pitchen@atmel.com>,
Linux mtd <linux-mtd@lists.infradead.org>,
Emese Revfy <re.emese@gmail.com>,
"kernel-hardening@lists.openwall.com"
<kernel-hardening@lists.openwall.com>
Subject: Re: [PATCH 23/31] gcc-plugins.txt: standardize document format
Date: Wed, 24 May 2017 10:35:42 -0700 [thread overview]
Message-ID: <CAGXu5jKyZEV+mvJUipfX5GMFqv=HYLoU-9C_1pYrc24J-0YaWg@mail.gmail.com> (raw)
In-Reply-To: <c6318a78ef026da30aa488bd90a5a19e18fc13a3.1495156488.git.mchehab@s-opensource.com>
On Thu, May 18, 2017 at 6:22 PM, Mauro Carvalho Chehab
<mchehab@s-opensource.com> wrote:
> Each text file under Documentation follows a different
> format. Some doesn't even have titles!
>
> Change its representation to follow the adopted standard,
> using ReST markups for it to be parseable by Sphinx:
>
> - promote main title;
> - use the right markup for footnotes;
> - use bold markup for files name;
> - identify literal blocks;
> - add blank lines to avoid Sphinx to complain;
> - remove numeration from titles.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Acked-by: Kees Cook <keescook@chromium.org>
This should probably get moved under "Kernel API documentation" but
may need a new sub-category, maybe "instrumentation"? Things like
KASan could be put under that too.
-Kees
--
Kees Cook
Pixel Security
next prev parent reply other threads:[~2017-05-24 17:35 UTC|newest]
Thread overview: 37+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-05-19 1:22 [PATCH 00/31] Standardize doc formats - part 1 Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 01/31] bcache.txt: standardize document format Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 02/31] bt8xxgpio.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 03/31] btmrvl.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 04/31] bus-virt-phys-mapping.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 05/31] cachetlb.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 06/31] cgroup-v2.txt: " Mauro Carvalho Chehab
2017-05-19 14:59 ` Tejun Heo
2017-06-17 15:18 ` Mauro Carvalho Chehab
2017-06-18 10:46 ` Tejun Heo
2017-05-19 1:22 ` [PATCH 07/31] circular-buffers.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 08/31] clk.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 09/31] cpu-load: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 10/31] cputopology.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 11/31] crc32.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 12/31] dcdbas.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 13/31] digsig.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 14/31] DMA-API.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 15/31] DMA-API-HOWTO.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 16/31] DMA-attributes.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 17/31] DMA-ISA-LPC.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 18/31] debugging-via-ohci1394.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 19/31] efi-stub.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 20/31] eisa.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 21/31] flexible-arrays.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 22/31] futex-requeue-pi.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 23/31] gcc-plugins.txt: " Mauro Carvalho Chehab
2017-05-24 17:35 ` Kees Cook [this message]
2017-05-24 20:18 ` Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 24/31] highuid.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 25/31] hw_random.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 26/31] hwspinlock.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 27/31] intel_txt.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 28/31] Intel-IOMMU.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 29/31] io-mapping.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 30/31] io_ordering.txt: " Mauro Carvalho Chehab
2017-05-19 1:22 ` [PATCH 31/31] iostats.txt: " 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='CAGXu5jKyZEV+mvJUipfX5GMFqv=HYLoU-9C_1pYrc24J-0YaWg@mail.gmail.com' \
--to=keescook@google.com \
--cc=boris.brezillon@free-electrons.com \
--cc=computersforpeace@gmail.com \
--cc=corbet@lwn.net \
--cc=cyrille.pitchen@atmel.com \
--cc=dwmw2@infradead.org \
--cc=kernel-hardening@lists.openwall.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mtd@lists.infradead.org \
--cc=marek.vasut@gmail.com \
--cc=mchehab@infradead.org \
--cc=mchehab@s-opensource.com \
--cc=re.emese@gmail.com \
--cc=richard@nod.at \
/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).