From: Bart Van Assche <Bart.VanAssche@wdc.com>
To: "corbet@lwn.net" <corbet@lwn.net>,
        "gregkh@linuxfoundation.org" <gregkh@linuxfoundation.org>
CC: "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
        "linux-doc@vger.kernel.org" <linux-doc@vger.kernel.org>
Subject: Re: [PATCH] driver core: Document struct device:dma_ops
Thread-Topic: [PATCH] driver core: Document struct device:dma_ops
Thread-Index: AQHTHSWhg/s4/Js8kEmmYV+EfSBZMKKUJIuA
Date: Thu, 24 Aug 2017 23:26:56 +0000
Message-ID: <1503616763.2899.123.camel@wdc.com>
References: <20170824160910.43c9b643@lwn.net>
In-Reply-To: <20170824160910.43c9b643@lwn.net>
Accept-Language: en-US
Content-Language: en-US
wdcipoutbound: EOP-TRUE
spamdiagnosticoutput: 1:99
spamdiagnosticmetadata: NSPM
Content-Type: text/plain; charset="utf-8"
Content-ID: <4931A769A1ABFC42B4178958B774B315@namprd04.prod.outlook.com>
MIME-Version: 1.0
X-MS-Exchange-CrossTenant-originalarrivaltime: 24 Aug 2017 23:26:56.5613
 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: b61c8803-16f3-4c35-9b17-6f65f441df86
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY1PR0401MB1067
Sender: linux-kernel-owner@vger.kernel.org
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
Content-Transfer-Encoding: 8bit
X-MIME-Autoconverted: from base64 to 8bit by nfs id v7ONRoir009672
Content-Length: 1258
Lines: 31

On Thu, 2017-08-24 at 16:09 -0600, Jonathan Corbet wrote:
> Commit 5657933dbb6e (treewide: Move dma_ops from struct dev_archdata into
> struct device) added the dma_ops field to struct device, but did not
> update the kerneldoc comment, yielding this warning:
> 
>   ./include/linux/device.h:969: warning: No description found for parameter 'dma_ops'
> 
> Add a description and bring a little peace to the world.
> 
> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
> ---
>  include/linux/device.h | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/include/linux/device.h b/include/linux/device.h
> index 723cd54b94da..ed9904728cda 100644
> --- a/include/linux/device.h
> +++ b/include/linux/device.h
> @@ -847,6 +847,7 @@ struct dev_links_info {
>   * @msi_list:	Hosts MSI descriptors
>   * @msi_domain: The generic MSI domain this device is using.
>   * @numa_node:	NUMA node this device is close to.
> + * @dma_ops:    DMA mapping operations for this device.
>   * @dma_mask:	Dma mask (if dma'ble device).
>   * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
>   * 		hardware supports 64-bit addresses for consistent allocations

Thanks Jonathan for this patch.

Reviewed-by: Bart Van Assche <bart.vanassche@wdc.com>