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

[Changbin Du]

On Tue, Apr 09, 2019 at 11:44:11PM +0200, Rafael J. Wysocki wrote:
> On Tue, Apr 9, 2019 at 11:26 PM Jonathan Corbet <corbet@xxxxxxx> wrote:
> >
> > On Tue, 9 Apr 2019 18:42:59 +0200
> > "Rafael J. Wysocki" <rafael@xxxxxxxxxx> 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.
> 
> The primary reason would be to retain the correspondence between the
> old and the new files.
> 
> I guess they could be combined, but that would be two sort of
> different changes in one go.
> 
> > In general the plan seems good.
> 
> OK, thanks!
> 
> Cheers,
> Rafael
Ok, if we have reached this greement, I probably do it this weekend. Thanks for your
comments.

-- 
Cheers,
Changbin Du