linux-kernel - Re: [PATCH v2 00/24] 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: <20190409152638.5b20c77f@lwn.net>
Date:   Tue, 9 Apr 2019 15:26:38 -0600
From:   Jonathan Corbet <corbet@....net>
To:     "Rafael J. Wysocki" <rafael@...nel.org>
Cc:     Changbin Du <changbin.du@...il.com>,
        "Rafael J. Wysocki" <rjw@...ysocki.net>,
        Len Brown <lenb@...nel.org>,
        ACPI Devel Maling List <linux-acpi@...r.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        "open list:DOCUMENTATION" <linux-doc@...r.kernel.org>
Subject: Re: [PATCH v2 00/24] Include linux ACPI docs into Sphinx TOC tree

On Tue, 9 Apr 2019 18:42:59 +0200
"Rafael J. Wysocki" <rafael@...nel.org> wrote:

> > Hardware guide  
> 
> This is more about documenting the expectations regarding the platform
> firmware, so what about firmware-guide instead?

I had imagined a slightly wider focus, but this seems OK for now.  We can
always rename it later :)

> So what about this:
> 
> - Create a new firmware-guide under Documentation and add an acpi/
> directory to it for starters.  Put the following files into it:
> 
>          acpi-lid
>          aml-debugger
>          debug (ditto)
>          DSD-properties-rules
>          gpio-properties
>          i2c-muxes
> 
> - Add an acpi/ subdirectory to Documentation/admin-guide and put the
> following files into it:
> 
>          cppc_sysfs
>          initrd_table_override
>          dsdt-override

I do wonder if, rather than creating a new directory, we shouldn't just
make a single acpi.rst and put that information into it?  

> - Add an acpi/ subdirectory to Documentation/driver-api and put the
> following files into it:
> 
>          enumeration
>          scan_handlers

...and something similar here?  I guess that would be my preference, but I
don't feel all that strongly about it if there's reasons to do otherwise.

In general the plan seems good.

Thanks,

jon