Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

devlink: fix kdoc

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>

authored by

Jakub Kicinski and committed by
David S. Miller
eeaadd82 6ae87626

+5 -7
+5 -7
net/core/devlink.c
··· 5249 5249 * devlink_register - Register devlink instance 5250 5250 * 5251 5251 * @devlink: devlink 5252 + * @dev: parent device 5252 5253 */ 5253 5254 int devlink_register(struct devlink *devlink, struct device *dev) 5254 5255 { ··· 5300 5299 * 5301 5300 * @devlink: devlink 5302 5301 * @devlink_port: devlink port 5303 - * @port_index 5302 + * @port_index: driver-specific numerical identifier of the port 5304 5303 * 5305 5304 * Register devlink port with provided port index. User can use 5306 5305 * any indexing, even hw-related one. devlink_port structure ··· 5630 5629 * 5631 5630 * @devlink: devlink 5632 5631 * @resource_name: resource's name 5633 - * @top_hierarchy: top hierarchy 5634 - * @reload_required: reload is required for new configuration to 5635 - * apply 5636 5632 * @resource_size: resource's size 5637 5633 * @resource_id: resource's id 5638 - * @parent_reosurce_id: resource's parent id 5639 - * @size params: size parameters 5634 + * @parent_resource_id: resource's parent id 5635 + * @size_params: size parameters 5640 5636 */ 5641 5637 int devlink_resource_register(struct devlink *devlink, 5642 5638 const char *resource_name, ··· 6330 6332 * Multiple snapshots can be created on a region. 6331 6333 * The @snapshot_id should be obtained using the getter function. 6332 6334 * 6333 - * @devlink_region: devlink region of the snapshot 6335 + * @region: devlink region of the snapshot 6334 6336 * @data_len: size of snapshot data 6335 6337 * @data: snapshot data 6336 6338 * @snapshot_id: snapshot id to be created