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

From: Rafael J. Wysocki
Date: Mon Jan 02 2017 - 17:11:18 EST


On Monday, December 19, 2016 09:36:39 PM Rafael J. Wysocki wrote:
> From: Rafael J. Wysocki <rafael.j.wysocki@xxxxxxxxx>
>
> 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@xxxxxxxxx>

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