linux-kernel - Re: [PATCH 11/30] kprobes.txt: standardize document format

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-Id: <20170519233827.3bd5d632420bc5a4ce70f85d@kernel.org>
Date:   Fri, 19 May 2017 23:38:27 +0900
From:   Masami Hiramatsu <mhiramat@...nel.org>
To:     Mauro Carvalho Chehab <mchehab@...pensource.com>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Mauro Carvalho Chehab <mchehab@...radead.org>,
        linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        David Woodhouse <dwmw2@...radead.org>,
        Brian Norris <computersforpeace@...il.com>,
        Boris Brezillon <boris.brezillon@...e-electrons.com>,
        Marek Vasut <marek.vasut@...il.com>,
        Richard Weinberger <richard@....at>,
        Cyrille Pitchen <cyrille.pitchen@...el.com>,
        linux-mtd@...ts.infradead.org,
        Ananth N Mavinakayanahalli <ananth@...ux.vnet.ibm.com>,
        Anil S Keshavamurthy <anil.s.keshavamurthy@...el.com>,
        "David S. Miller" <davem@...emloft.net>,
        Masami Hiramatsu <mhiramat@...nel.org>
Subject: Re: [PATCH 11/30] kprobes.txt: standardize document format

On Thu, 18 May 2017 22:24:03 -0300
Mauro Carvalho Chehab <mchehab@...pensource.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:
> 
> - comment the contents;
> - add proper markups for titles;
> - mark literal blocks as such;
> - use :Author: for authorship;
> - use the right markups for footnotes;
> - escape some literals that would otherwise cause problems;
> - fix identation and add blank lines where needed.

OK, it seems good to me.

Acked-by: Masami Hiramatsu <mhiramat@...nel.org>

By the way, there are some words which referes other section
in this document, should it also be updated according to
Sphinx format?

e.g.
[snip]
> @@ -53,7 +59,8 @@ a post_handler, and how to use the maxactive and nmissed fields of
>  a kretprobe.  But if you're in a hurry to start using Kprobes, you
>  can skip ahead to section 2.

here, it refers "section 2".

Thank you,


-- 
Masami Hiramatsu <mhiramat@...nel.org>