Re: [PATCH 00/23] Include linux ACPI docs into Sphinx TOC tree

From: Changbin Du
Date: Thu Mar 28 2019 - 20:10:34 EST


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@xxxxxxxxx> 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