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

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]

Date:   Mon, 02 Jan 2017 23:05:31 +0100
From:   "Rafael J. Wysocki" <rjw@...ysocki.net>
To:     Jonathan Corbet <corbet@....net>,
        Linux PM <linux-pm@...r.kernel.org>
Cc:     LKML <linux-kernel@...r.kernel.org>,
        Mauro Carvalho Chehab <mchehab@....samsung.com>,
        Linux Documentation <linux-doc@...r.kernel.org>
Subject: Re: [PATCH] PM / docs: Drop confusing kernel-doc references from infrastructure.rst

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