• Pavan Kumar Linga's avatar
    scripts: kernel-doc: fix macro handling in enums · 0ef5de7b
    Pavan Kumar Linga authored
    drivers/net/ethernet/intel/idpf/idpf.h uses offsetof to
    initialize the enum enumerators:
    
    enum idpf_cap_field {
    	IDPF_BASE_CAPS = -1,
    	IDPF_CSUM_CAPS = offsetof(struct virtchnl2_get_capabilities,
    				  csum_caps),
    	IDPF_SEG_CAPS = offsetof(struct virtchnl2_get_capabilities,
    				 seg_caps),
    	IDPF_RSS_CAPS = offsetof(struct virtchnl2_get_capabilities,
    				 rss_caps),
    	IDPF_HSPLIT_CAPS = offsetof(struct virtchnl2_get_capabilities,
    				    hsplit_caps),
    	IDPF_RSC_CAPS = offsetof(struct virtchnl2_get_capabilities,
    				 rsc_caps),
    	IDPF_OTHER_CAPS = offsetof(struct virtchnl2_get_capabilities,
    				   other_caps),
    };
    
    kernel-doc parses the above enumerator with a ',' inside the
    macro and treats 'csum_caps', 'seg_caps' etc. also as enumerators
    resulting in the warnings:
    
    drivers/net/ethernet/intel/idpf/idpf.h:130: warning: Enum value
    'csum_caps' not described in enum 'idpf_cap_field'
    drivers/net/ethernet/intel/idpf/idpf.h:130: warning: Enum value
    'seg_caps' not described in enum 'idpf_cap_field'
    drivers/net/ethernet/intel/idpf/idpf.h:130: warning: Enum value
    'rss_caps' not described in enum 'idpf_cap_field'
    drivers/net/ethernet/intel/idpf/idpf.h:130: warning: Enum value
    'hsplit_caps' not described in enum 'idpf_cap_field'
    drivers/net/ethernet/intel/idpf/idpf.h:130: warning: Enum value
    'rsc_caps' not described in enum 'idpf_cap_field'
    drivers/net/ethernet/intel/idpf/idpf.h:130: warning: Enum value
    'other_caps' not described in enum 'idpf_cap_field'
    
    Fix it by removing the macro arguments within the parentheses.
    
    Cc: Jonathan Corbet <corbet@lwn.net>
    Signed-off-by: default avatarPavan Kumar Linga <pavan.kumar.linga@intel.com>
    Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
    Link: https://lore.kernel.org/r/20230815210417.98749-3-pavan.kumar.linga@intel.com
    0ef5de7b
kernel-doc 67.2 KB