linux-kernel - Re: [PATCH 01/29] pinctrl.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] [thread-next>] [day] [month] [year] [list]

Date:   Sat, 17 Jun 2017 12:03:01 -0300
From:   Mauro Carvalho Chehab <mchehab@...pensource.com>
To:     Linus Walleij <linus.walleij@...aro.org>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Mauro Carvalho Chehab <mchehab@...radead.org>,
        "linux-kernel@...r.kernel.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" <linux-mtd@...ts.infradead.org>,
        "linux-gpio@...r.kernel.org" <linux-gpio@...r.kernel.org>
Subject: Re: [PATCH 01/29] pinctrl.txt: standardize document format

Em Tue, 23 May 2017 11:12:43 +0200
Linus Walleij <linus.walleij@...aro.org> escreveu:

> On Fri, May 19, 2017 at 3:25 AM, 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.
> >
> > This document is almost following the standard stile.
> >
> > There are only two things to adjust on it:
> >
> > - promote the level of the document title;
> > - mark literal blocks as such.
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab@...pensource.com>  
> 
> I applied the patch fixing some of the indentation mistakes pointed
> out by Geert.

Thanks!

(sorry for not answering earlier... got sidetracked by two trips)

> Should the file be renamed pinctrl.rst now?

If you just rename it, Sphinx will complain because it doesn't
belong to any index.rst file. As this is part of drivers/, I guess
the right thing is to add it to driver-api book.

The enclosed patch should be doing it (it is based on linux-next).

Thanks,
Mauro

[PATCH] pinctrl.txt: move it to the driver-api book

As pinctrl describes a feature from drivers/base, place it at
the right book.

Signed-off-by: Mauro Carvalho Chehab <mchehab@...pensource.com>

diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 3cf1acebc4ee..7c94ab50afed 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -43,6 +43,7 @@ available subsections can be seen below.
    80211/index
    uio-howto
    firmware/index
+   pinctl
    misc_devices
 
 .. only::  subproject and html
diff --git a/Documentation/pinctrl.txt b/Documentation/driver-api/pinctl.rst
similarity index 100%
rename from Documentation/pinctrl.txt
rename to Documentation/driver-api/pinctl.rst