• Randy Dunlap's avatar
    devlink: fix kernel-doc notation warnings · 839f55c5
    Randy Dunlap authored
    Spell function or struct member names correctly.
    Use ':' instead of '-' for struct member entries.
    Mark one field as private in kernel-doc.
    Add a few entries that were missing.
    Fix a typo.
    
    These changes prevent kernel-doc warnings:
    
    devlink.h:252: warning: Function parameter or member 'field_id' not described in 'devlink_dpipe_match'
    devlink.h:267: warning: Function parameter or member 'field_id' not described in 'devlink_dpipe_action'
    devlink.h:310: warning: Function parameter or member 'match_values_count' not described in 'devlink_dpipe_entry'
    devlink.h:355: warning: Function parameter or member 'list' not described in 'devlink_dpipe_table'
    devlink.h:374: warning: Function parameter or member 'actions_dump' not described in 'devlink_dpipe_table_ops'
    devlink.h:374: warning: Function parameter or member 'matches_dump' not described in 'devlink_dpipe_table_ops'
    devlink.h:374: warning: Function parameter or member 'entries_dump' not described in 'devlink_dpipe_table_ops'
    devlink.h:374: warning: Function parameter or member 'counters_set_update' not described in 'devlink_dpipe_table_ops'
    devlink.h:374: warning: Function parameter or member 'size_get' not described in 'devlink_dpipe_table_ops'
    devlink.h:384: warning: Function parameter or member 'headers' not described in 'devlink_dpipe_headers'
    devlink.h:384: warning: Function parameter or member 'headers_count' not described in 'devlink_dpipe_headers'
    devlink.h:398: warning: Function parameter or member 'unit' not described in 'devlink_resource_size_params'
    devlink.h:487: warning: Function parameter or member 'id' not described in 'devlink_param'
    devlink.h:645: warning: Function parameter or member 'overwrite_mask' not described in 'devlink_flash_update_params'
    
    Fixes: 1555d204 ("devlink: Support for pipeline debug (dpipe)")
    Fixes: d9f9b9a4 ("devlink: Add support for resource abstraction")
    Fixes: eabaef18 ("devlink: Add devlink_param register and unregister")
    Fixes: 5d5b4128 ("devlink: introduce flash update overwrite mask")
    Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
    Cc: Jiri Pirko <jiri@resnulli.us>
    Cc: Moshe Shemesh <moshe@mellanox.com>
    Cc: Jacob Keller <jacob.e.keller@intel.com>
    Link: https://lore.kernel.org/r/20230714045127.18752-5-rdunlap@infradead.orgSigned-off-by: default avatarJakub Kicinski <kuba@kernel.org>
    839f55c5
devlink.h 69.4 KB