Skip to content

Commit

Permalink
devlink: fix kdoc
Browse files Browse the repository at this point in the history
devlink suffers from a few kdoc warnings:

net/core/devlink.c:5292: warning: Function parameter or member 'dev' not described in 'devlink_register'
net/core/devlink.c:5351: warning: Function parameter or member 'port_index' not described in 'devlink_port_register'
net/core/devlink.c:5753: warning: Function parameter or member 'parent_resource_id' not described in 'devlink_resource_register'
net/core/devlink.c:5753: warning: Function parameter or member 'size_params' not described in 'devlink_resource_register'
net/core/devlink.c:5753: warning: Excess function parameter 'top_hierarchy' description in 'devlink_resource_register'
net/core/devlink.c:5753: warning: Excess function parameter 'reload_required' description in 'devlink_resource_register'
net/core/devlink.c:5753: warning: Excess function parameter 'parent_reosurce_id' description in 'devlink_resource_register'
net/core/devlink.c:6451: warning: Function parameter or member 'region' not described in 'devlink_region_snapshot_create'
net/core/devlink.c:6451: warning: Excess function parameter 'devlink_region' description in 'devlink_region_snapshot_create'

Signed-off-by: Jakub Kicinski <jakub.kicinski@netronome.com>
Acked-by: Jiri Pirko <jiri@mellanox.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
  • Loading branch information
Jakub Kicinski authored and David S. Miller committed Mar 2, 2019
1 parent 6ae8762 commit eeaadd8
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions net/core/devlink.c
Original file line number Diff line number Diff line change
Expand Up @@ -5249,6 +5249,7 @@ EXPORT_SYMBOL_GPL(devlink_alloc);
* devlink_register - Register devlink instance
*
* @devlink: devlink
* @dev: parent device
*/
int devlink_register(struct devlink *devlink, struct device *dev)
{
Expand Down Expand Up @@ -5299,7 +5300,7 @@ EXPORT_SYMBOL_GPL(devlink_free);
*
* @devlink: devlink
* @devlink_port: devlink port
* @port_index
* @port_index: driver-specific numerical identifier of the port
*
* Register devlink port with provided port index. User can use
* any indexing, even hw-related one. devlink_port structure
Expand Down Expand Up @@ -5629,13 +5630,10 @@ EXPORT_SYMBOL_GPL(devlink_dpipe_table_unregister);
*
* @devlink: devlink
* @resource_name: resource's name
* @top_hierarchy: top hierarchy
* @reload_required: reload is required for new configuration to
* apply
* @resource_size: resource's size
* @resource_id: resource's id
* @parent_reosurce_id: resource's parent id
* @size params: size parameters
* @parent_resource_id: resource's parent id
* @size_params: size parameters
*/
int devlink_resource_register(struct devlink *devlink,
const char *resource_name,
Expand Down Expand Up @@ -6332,7 +6330,7 @@ EXPORT_SYMBOL_GPL(devlink_region_shapshot_id_get);
* Multiple snapshots can be created on a region.
* The @snapshot_id should be obtained using the getter function.
*
* @devlink_region: devlink region of the snapshot
* @region: devlink region of the snapshot
* @data_len: size of snapshot data
* @data: snapshot data
* @snapshot_id: snapshot id to be created
Expand Down

0 comments on commit eeaadd8

Please sign in to comment.