From: Changbin Du <changbin.du@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Changbin Du <changbin.du@gmail.com>,
rjw@rjwysocki.net, lenb@kernel.org, linux-acpi@vger.kernel.org,
linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org
Subject: Re: [PATCH 00/23] Include linux ACPI docs into Sphinx TOC tree
Date: Fri, 29 Mar 2019 08:10:22 +0800 [thread overview]
Message-ID: <20190329001020.utauchuqsqt5maww@mail.google.com> (raw)
In-Reply-To: <20190328103902.1084337d@lwn.net>
On Thu, Mar 28, 2019 at 10:39:02AM -0600, Jonathan Corbet wrote:
> On Fri, 29 Mar 2019 00:26:58 +0800
> Changbin Du <changbin.du@gmail.com> wrote:
>
> > The kernel now uses Sphinx to generate intelligent and beautiful documentation
> > from reStructuredText files. I converted most of the Linux ACPI docs to rst
> > format in this serias.
>
> Thanks for doing this. I've only looked quickly at this point, so I just
> have a couple of high-level comments.
>
> - If at all possible, I would really rather this not be placed in the
> top-level of the document tree. Things are far too cluttered there
> already; I would prefer to take stuff out instead.
>
> That said, I'm not at this point sure of where I think it should go.
> We may want to consider splitting it up; some of it appears to be
> suitable for the driver API manual, while some of it might be best in
> the admin guide. And some probably doesn't fit either. I'll try to
> ponder on this a bit more.
>
Agree, they should be arranged for different roles of readers.
> - It would be a good idea to add SPDX tags to the files while you're
> working through them.
>
Will add them. Thanks for reviewing.
> Thanks,
>
> jon
--
Cheers,
Changbin Du
prev parent reply other threads:[~2019-03-29 0:10 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-03-28 16:26 [PATCH 00/23] Include linux ACPI docs into Sphinx TOC tree Changbin Du
2019-03-28 16:26 ` [PATCH 01/23] Documentation: add Linux ACPI to " Changbin Du
2019-03-28 16:27 ` [PATCH 02/23] acpi doc: convert acpi/namespace.txt to rst format Changbin Du
2019-03-28 16:27 ` [PATCH 03/23] acpi doc: convert acpi/enumeration.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 04/23] acpi doc: convert acpi/osi.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 05/23] acpi doc: convert acpi/linuxized-acpica.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 06/23] acpi doc: convert acpi/scan_handlers.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 07/23] acpi doc: convert acpi/DSD-properties-rules.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 08/23] acpi doc: convert acpi/gpio-properties.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 09/23] acpi doc: convert acpi/method-customizing.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 10/23] acpi doc: convert acpi/initrd_table_override.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 11/23] acpi doc: convert acpi/dsdt-override.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 12/23] acpi doc: convert acpi/i2c-muxes.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 13/23] acpi doc: convert acpi/acpi-lid.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 14/23] acpi doc: convert acpi/dsd/graph.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 15/23] acpi doc: convert acpi/debug.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 16/23] acpi doc: convert acpi/method-tracing.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 17/23] acpi doc: convert acpi/aml-debugger.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 18/23] acpi doc: convert acpi/apei/output_format.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 19/23] acpi doc: convert acpi/apei/einj.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 20/23] acpi doc: convert acpi/cppc_sysfs.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 21/23] acpi doc: convert acpi/lpit.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 22/23] acpi doc: convert acpi/ssdt-overlays.txt " Changbin Du
2019-03-28 16:27 ` [PATCH 23/23] acpi doc: convert acpi/video_extension.txt " Changbin Du
2019-03-28 16:34 ` [PATCH 00/23] Include linux ACPI docs into Sphinx TOC tree Joe Perches
2019-03-29 0:08 ` Changbin Du
2019-03-28 16:39 ` Jonathan Corbet
2019-03-29 0:10 ` Changbin Du [this message]
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=20190329001020.utauchuqsqt5maww@mail.google.com \
--to=changbin.du@gmail.com \
--cc=corbet@lwn.net \
--cc=lenb@kernel.org \
--cc=linux-acpi@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rjw@rjwysocki.net \
/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).