diff mbox

mod_devicetable.h: Fix docs build warnings

Message ID 20170724135417.295707db@lwn.net
State New
Headers show

Commit Message

Jonathan Corbet July 24, 2017, 7:54 p.m. UTC
Commit 0afef45654ae908536278ecb143ded5bbc713391 (staging: fsl-mc: add
support for device table matching) added kerneldoc comments for two
nonexistent structure fields, leading to these warnings in the docs build:

  ./include/linux/mod_devicetable.h:687: warning: Excess struct/union/enum/typedef member 'ver_major' description in 'fsl_mc_device_id'
  ./include/linux/mod_devicetable.h:687: warning: Excess struct/union/enum/typedef member 'ver_minor' description in 'fsl_mc_device_id'

Remove the offending lines to make the docs build a bit quieter.

CC: Stuart Yoder <stuart.yoder@nxp.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

---
Greg, you seem as likely a person as any to take this one...?

 include/linux/mod_devicetable.h | 2 --
 1 file changed, 2 deletions(-)

-- 
2.9.4

Comments

Greg KH Aug. 28, 2017, 2:19 p.m. UTC | #1
On Mon, Jul 24, 2017 at 01:54:17PM -0600, Jonathan Corbet wrote:
> Commit 0afef45654ae908536278ecb143ded5bbc713391 (staging: fsl-mc: add

> support for device table matching) added kerneldoc comments for two

> nonexistent structure fields, leading to these warnings in the docs build:

> 

>   ./include/linux/mod_devicetable.h:687: warning: Excess struct/union/enum/typedef member 'ver_major' description in 'fsl_mc_device_id'

>   ./include/linux/mod_devicetable.h:687: warning: Excess struct/union/enum/typedef member 'ver_minor' description in 'fsl_mc_device_id'

> 

> Remove the offending lines to make the docs build a bit quieter.

> 

> CC: Stuart Yoder <stuart.yoder@nxp.com>

> Signed-off-by: Jonathan Corbet <corbet@lwn.net>

> ---

> Greg, you seem as likely a person as any to take this one...?


Yes, I'll take it, someone else just sent this to me before you did so
I'll add your signed-off-by to it and use it.

thanks,

greg k-h
diff mbox

Patch

diff --git a/include/linux/mod_devicetable.h b/include/linux/mod_devicetable.h
index 3f74ef2281e8..694cebb50f72 100644
--- a/include/linux/mod_devicetable.h
+++ b/include/linux/mod_devicetable.h
@@ -674,8 +674,6 @@  struct ulpi_device_id {
  * struct fsl_mc_device_id - MC object device identifier
  * @vendor: vendor ID
  * @obj_type: MC object type
- * @ver_major: MC object version major number
- * @ver_minor: MC object version minor number
  *
  * Type of entries in the "device Id" table for MC object devices supported by
  * a MC object device driver. The last entry of the table has vendor set to 0x0