[PATCH] PM / docs: Drop confusing kernel-doc references from infrastructure.rst

[PATCH] PM / docs: Drop confusing kernel-doc references from infrastructure.rst

[Rafael J. Wysocki]

From: Rafael J. Wysocki <rafael.j.wysocki@intel.com>

The references to drivers/base/power/main.c and
drivers/acpi/scan.c from Documentation/driver-api/infrastructure.rst
are confusing.  They both cause descriptions of functions that are
not relevant to device drivers at all to be generated and none of
them is sufficient to cover the API in a meaningful way.

Drop them for now.

Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
---
 Documentation/driver-api/infrastructure.rst |   15 ---------------
 1 file changed, 15 deletions(-)

Index: linux-pm/Documentation/driver-api/infrastructure.rst
===================================================================
--- linux-pm.orig/Documentation/driver-api/infrastructure.rst
+++ linux-pm/Documentation/driver-api/infrastructure.rst
@@ -55,21 +55,6 @@ Device Drivers DMA Management
 .. kernel-doc:: drivers/base/dma-mapping.c
    :export:
 
-Device Drivers Power Management
--------------------------------
-
-.. kernel-doc:: drivers/base/power/main.c
-   :export:
-
-Device Drivers ACPI Support
----------------------------
-
-.. kernel-doc:: drivers/acpi/scan.c
-   :export:
-
-.. kernel-doc:: drivers/acpi/scan.c
-   :internal:
-
 Device drivers PnP support
 --------------------------
 

Re: [PATCH] PM / docs: Drop confusing kernel-doc references from infrastructure.rst

[Rafael J. Wysocki]

On Monday, December 19, 2016 09:36:39 PM Rafael J. Wysocki wrote:
> From: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
> 
> The references to drivers/base/power/main.c and
> drivers/acpi/scan.c from Documentation/driver-api/infrastructure.rst
> are confusing.  They both cause descriptions of functions that are
> not relevant to device drivers at all to be generated and none of
> them is sufficient to cover the API in a meaningful way.
> 
> Drop them for now.
> 
> Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>

I'd like this to go into 4.10.

Are there any objections here?

> ---
>  Documentation/driver-api/infrastructure.rst |   15 ---------------
>  1 file changed, 15 deletions(-)
> 
> Index: linux-pm/Documentation/driver-api/infrastructure.rst
> ===================================================================
> --- linux-pm.orig/Documentation/driver-api/infrastructure.rst
> +++ linux-pm/Documentation/driver-api/infrastructure.rst
> @@ -55,21 +55,6 @@ Device Drivers DMA Management
>  .. kernel-doc:: drivers/base/dma-mapping.c
>     :export:
>  
> -Device Drivers Power Management
> --------------------------------
> -
> -.. kernel-doc:: drivers/base/power/main.c
> -   :export:
> -
> -Device Drivers ACPI Support
> ----------------------------
> -
> -.. kernel-doc:: drivers/acpi/scan.c
> -   :export:
> -
> -.. kernel-doc:: drivers/acpi/scan.c
> -   :internal:
> -
>  Device drivers PnP support
>  --------------------------
>  
> 
> --

Thanks,
Rafael

Re: [PATCH] PM / docs: Drop confusing kernel-doc references from infrastructure.rst

[Rafael J. Wysocki]

On Monday, January 02, 2017 03:39:20 PM Jonathan Corbet wrote:
> On Mon, 02 Jan 2017 23:05:31 +0100
> "Rafael J. Wysocki" <rjw@rjwysocki.net> wrote:
> 
> > > From: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
> > > 
> > > The references to drivers/base/power/main.c and
> > > drivers/acpi/scan.c from Documentation/driver-api/infrastructure.rst
> > > are confusing.  They both cause descriptions of functions that are
> > > not relevant to device drivers at all to be generated and none of
> > > them is sufficient to cover the API in a meaningful way.
> > > 
> > > Drop them for now.
> > > 
> > > Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>  
> > 
> > I'd like this to go into 4.10.
> > 
> > Are there any objections here?
> 
> None here.  Sorry, somehow I failed to see this when I was putting
> together the fixes to send a few days ago.  If you want to include it in
> a batch of yours, feel free to do so with my ack; otherwise I can ship it
> Linusward in a bit.

Thanks!

I'll be sending a PM pull request in a couple of days, so I'll include this one.

Cheers,
Rafael

Re: [PATCH] PM / docs: Drop confusing kernel-doc references from infrastructure.rst

[Jonathan Corbet]

On Mon, 02 Jan 2017 23:05:31 +0100
"Rafael J. Wysocki" <rjw@rjwysocki.net> wrote:

> > From: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
> > 
> > The references to drivers/base/power/main.c and
> > drivers/acpi/scan.c from Documentation/driver-api/infrastructure.rst
> > are confusing.  They both cause descriptions of functions that are
> > not relevant to device drivers at all to be generated and none of
> > them is sufficient to cover the API in a meaningful way.
> > 
> > Drop them for now.
> > 
> > Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>  
> 
> I'd like this to go into 4.10.
> 
> Are there any objections here?

None here.  Sorry, somehow I failed to see this when I was putting
together the fixes to send a few days ago.  If you want to include it in
a batch of yours, feel free to do so with my ack; otherwise I can ship it
Linusward in a bit.

Thanks,

jon