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

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]

Message-ID: <20190328103902.1084337d@lwn.net>
Date:   Thu, 28 Mar 2019 10:39:02 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Changbin Du <changbin.du@...il.com>
Cc:     rjw@...ysocki.net, lenb@...nel.org, linux-acpi@...r.kernel.org,
        linux-kernel@...r.kernel.org, linux-doc@...r.kernel.org
Subject: Re: [PATCH 00/23] Include linux ACPI docs into Sphinx TOC tree

On Fri, 29 Mar 2019 00:26:58 +0800
Changbin Du <changbin.du@...il.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.

 - It would be a good idea to add SPDX tags to the files while you're
   working through them.

Thanks,

jon