From: Linus Walleij <linus.walleij@linaro.org> To: "Jonathan Neuschäfer" <j.neuschaefer@gmx.net> Cc: "open list:GPIO SUBSYSTEM" <linux-gpio@vger.kernel.org>, "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>, linux-doc@vger.kernel.org Subject: Re: [PATCH 0/8] Move most GPIO documentation to driver-api/gpio/ and ReST Date: Sat, 10 Mar 2018 12:50:46 +0100 [thread overview] Message-ID: <CACRpkda=5i-j=W8+yosF9WiZRKFF=iRC-djja7MJE+k6b1xtaQ@mail.gmail.com> (raw) In-Reply-To: <20180308234024.24145-1-j.neuschaefer@gmx.net> On Fri, Mar 9, 2018 at 12:40 AM, Jonathan Neuschäfer <j.neuschaefer@gmx.net> wrote: > The aim of this patchset is to move the GPIO subsystem's documentation > under Documentation/driver-api/gpio/ such that it is picked up by Sphinx > and compiled into HTML. Awesome! > I moved everything except for sysfs.txt, because > this file describes the legacy sysfs ABI, and doesn't seem to serve much > (non-historical) purpose anymore. > > There are still some rough edges: > > * I think the API documentation (kernel-doc) should be moved out of > index.rst into more appropriate files. > * The headings are arguably wrong, because driver.rst, consumer.rst, > etc. use the "document title" style, even though they are part of the > GPIO chapter. But the resulting TOC tree is consistent, and I did not > want to change almost all headings. > * Some of the files could use more :c:func:`...` references and general > ReST polish. > > But I don't want to make this patchset too large. It's fine, we take it one step at a time. On Fri, Mar 09, 2018 at 10:41:20AM -0700, Jonathan Corbet wrote: > Anyway, I'm happy to take these through the docs tree or see them go via > GPIO; Linus, what's your preference? I might have some doc patches that could collide so I can take them. I take it there will be a v2? Yours, Linus Walleij
WARNING: multiple messages have this Message-ID (diff)
From: Linus Walleij <linus.walleij@linaro.org> To: "Jonathan Neuschäfer" <j.neuschaefer@gmx.net> Cc: "open list:GPIO SUBSYSTEM" <linux-gpio@vger.kernel.org>, "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>, linux-doc@vger.kernel.org Subject: Re: [PATCH 0/8] Move most GPIO documentation to driver-api/gpio/ and ReST Date: Sat, 10 Mar 2018 12:50:46 +0100 [thread overview] Message-ID: <CACRpkda=5i-j=W8+yosF9WiZRKFF=iRC-djja7MJE+k6b1xtaQ@mail.gmail.com> (raw) In-Reply-To: <20180308234024.24145-1-j.neuschaefer@gmx.net> On Fri, Mar 9, 2018 at 12:40 AM, Jonathan Neuschäfer <j.neuschaefer@gmx.net> wrote: > The aim of this patchset is to move the GPIO subsystem's documentation > under Documentation/driver-api/gpio/ such that it is picked up by Sphinx > and compiled into HTML. Awesome! > I moved everything except for sysfs.txt, because > this file describes the legacy sysfs ABI, and doesn't seem to serve much > (non-historical) purpose anymore. > > There are still some rough edges: > > * I think the API documentation (kernel-doc) should be moved out of > index.rst into more appropriate files. > * The headings are arguably wrong, because driver.rst, consumer.rst, > etc. use the "document title" style, even though they are part of the > GPIO chapter. But the resulting TOC tree is consistent, and I did not > want to change almost all headings. > * Some of the files could use more :c:func:`...` references and general > ReST polish. > > But I don't want to make this patchset too large. It's fine, we take it one step at a time. On Fri, Mar 09, 2018 at 10:41:20AM -0700, Jonathan Corbet wrote: > Anyway, I'm happy to take these through the docs tree or see them go via > GPIO; Linus, what's your preference? I might have some doc patches that could collide so I can take them. I take it there will be a v2? Yours, Linus Walleij -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
next prev parent reply other threads:[~2018-03-10 11:50 UTC|newest] Thread overview: 27+ messages / expand[flat|nested] mbox.gz Atom feed top 2018-03-08 23:40 [PATCH 0/8] Move most GPIO documentation to driver-api/gpio/ and ReST Jonathan Neuschäfer 2018-03-08 23:40 ` Jonathan Neuschäfer 2018-03-08 23:40 ` [PATCH 1/8] MAINTAINERS: GPIO: Add Documentation/driver-api/gpio/ Jonathan Neuschäfer 2018-03-08 23:40 ` Jonathan Neuschäfer 2018-03-08 23:40 ` [PATCH 2/8] Documentation: driver-api: Move gpio.rst to gpio/index.rst Jonathan Neuschäfer 2018-03-08 23:40 ` Jonathan Neuschäfer 2018-03-08 23:40 ` [PATCH 3/8] Documentation: gpio: Move introduction to driver-api Jonathan Neuschäfer 2018-03-08 23:40 ` Jonathan Neuschäfer 2018-03-08 23:40 ` [PATCH 4/8] Documentation: gpio: Move driver documentation " Jonathan Neuschäfer 2018-03-08 23:40 ` Jonathan Neuschäfer 2018-03-08 23:40 ` [PATCH 5/8] Documentation: gpio: Move legacy " Jonathan Neuschäfer 2018-03-08 23:40 ` Jonathan Neuschäfer 2018-03-08 23:40 ` [PATCH 6/8] Documentation: gpio: Move gpiod_* consumer " Jonathan Neuschäfer 2018-03-08 23:40 ` Jonathan Neuschäfer 2018-03-08 23:40 ` [PATCH 7/8] Documentation: gpio: Move GPIO mapping " Jonathan Neuschäfer 2018-03-08 23:40 ` Jonathan Neuschäfer 2018-03-08 23:40 ` [PATCH 8/8] Documentation: gpio: Move drivers-on-gpio.txt " Jonathan Neuschäfer 2018-03-08 23:40 ` Jonathan Neuschäfer 2018-03-09 17:41 ` [PATCH 0/8] Move most GPIO documentation to driver-api/gpio/ and ReST Jonathan Corbet 2018-03-09 17:41 ` Jonathan Corbet 2018-03-10 11:18 ` Jonathan Neuschäfer 2018-03-10 11:50 ` Linus Walleij [this message] 2018-03-10 11:50 ` Linus Walleij 2018-03-10 13:29 ` Jonathan Neuschäfer 2018-03-23 3:23 ` Linus Walleij 2018-03-23 3:23 ` Linus Walleij 2018-03-23 14:24 ` Jonathan Neuschäfer
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='CACRpkda=5i-j=W8+yosF9WiZRKFF=iRC-djja7MJE+k6b1xtaQ@mail.gmail.com' \ --to=linus.walleij@linaro.org \ --cc=j.neuschaefer@gmx.net \ --cc=linux-doc@vger.kernel.org \ --cc=linux-gpio@vger.kernel.org \ --cc=linux-kernel@vger.kernel.org \ /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: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.