mirrors/linux
1
0
Fork 1
mirror of https://github.com/torvalds/linux.git synced 2025-10-31 16:48:26 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

userns: eliminate many kernel-doc warnings

Browse source 
Drop the kernel-doc "/**" notation from 8 structs or functions to
prevent 22 kernel-doc warnings  (samples below).

user_namespace.c:239: warning: Function parameter or member 'map_up' not described in 'idmap_key'
user_namespace.c:246: warning: Function parameter or member 'k' not described in 'cmp_map_id'
user_namespace.c:277: warning: Function parameter or member 'extents' not described in 'map_id_range_down_max'
user_namespace.c:295: warning: Function parameter or member 'extents' not described in 'map_id_range_down_base'
user_namespace.c:344: warning: Function parameter or member 'extents' not described in 'map_id_up_base'
user_namespace.c:364: warning: Function parameter or member 'extents' not described in 'map_id_up_max'
user_namespace.c:776: warning: Function parameter or member 'map' not described in 'insert_extent'
user_namespace.c:844: warning: Function parameter or member 'map' not described in 'sort_idmaps'

Fixes: 6397fac491 ("userns: bump idmap limits to 340")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20230830163215.13193-1-rdunlap@infradead.org
Cc: Eric Biederman <ebiederm@xmission.com>
Cc: Christian Brauner <brauner@kernel.org>
Signed-off-by: Christian Brauner <brauner@kernel.org>
This commit is contained in:
Randy Dunlap 2023-08-30 09:32:15 -07:00 committed by Christian Brauner
parent d218569004
commit f73f6181eb
1 changed files with 8 additions and 8 deletions
repo.diff.show_diff_stats Download patch file Download diff file Expand all files Collapse all files

16
kernel/user_namespace.c
View file

@ -231,7 +231,7 @@ void __put_user_ns(struct user_namespace *ns)
} }
EXPORT_SYMBOL(__put_user_ns); EXPORT_SYMBOL(__put_user_ns);
/** /*
* struct idmap_key - holds the information necessary to find an idmapping in a * struct idmap_key - holds the information necessary to find an idmapping in a
* sorted idmap array. It is passed to cmp_map_id() as first argument. * sorted idmap array. It is passed to cmp_map_id() as first argument.
*/ */
@ -241,7 +241,7 @@ struct idmap_key {
u32 count; /* == 0 unless used with map_id_range_down() */ u32 count; /* == 0 unless used with map_id_range_down() */
}; };
/** /*
* cmp_map_id - Function to be passed to bsearch() to find the requested * cmp_map_id - Function to be passed to bsearch() to find the requested
* idmapping. Expects struct idmap_key to be passed via @k. * idmapping. Expects struct idmap_key to be passed via @k.
*/ */
@ -271,7 +271,7 @@ static int cmp_map_id(const void *k, const void *e)
return 1; return 1;
} }
/** /*
* map_id_range_down_max - Find idmap via binary search in ordered idmap array. * map_id_range_down_max - Find idmap via binary search in ordered idmap array.
* Can only be called if number of mappings exceeds UID_GID_MAP_MAX_BASE_EXTENTS. * Can only be called if number of mappings exceeds UID_GID_MAP_MAX_BASE_EXTENTS.
*/ */
@ -288,7 +288,7 @@ map_id_range_down_max(unsigned extents, struct uid_gid_map *map, u32 id, u32 cou
sizeof(struct uid_gid_extent), cmp_map_id); sizeof(struct uid_gid_extent), cmp_map_id);
} }
/** /*
* map_id_range_down_base - Find idmap via binary search in static extent array. * map_id_range_down_base - Find idmap via binary search in static extent array.
* Can only be called if number of mappings is equal or less than * Can only be called if number of mappings is equal or less than
* UID_GID_MAP_MAX_BASE_EXTENTS. * UID_GID_MAP_MAX_BASE_EXTENTS.
@ -337,7 +337,7 @@ static u32 map_id_down(struct uid_gid_map *map, u32 id)
return map_id_range_down(map, id, 1); return map_id_range_down(map, id, 1);
} }
/** /*
* map_id_up_base - Find idmap via binary search in static extent array. * map_id_up_base - Find idmap via binary search in static extent array.
* Can only be called if number of mappings is equal or less than * Can only be called if number of mappings is equal or less than
* UID_GID_MAP_MAX_BASE_EXTENTS. * UID_GID_MAP_MAX_BASE_EXTENTS.
@ -358,7 +358,7 @@ map_id_up_base(unsigned extents, struct uid_gid_map *map, u32 id)
return NULL; return NULL;
} }
/** /*
* map_id_up_max - Find idmap via binary search in ordered idmap array. * map_id_up_max - Find idmap via binary search in ordered idmap array.
* Can only be called if number of mappings exceeds UID_GID_MAP_MAX_BASE_EXTENTS. * Can only be called if number of mappings exceeds UID_GID_MAP_MAX_BASE_EXTENTS.
*/ */
@ -770,7 +770,7 @@ static bool mappings_overlap(struct uid_gid_map *new_map,
return false; return false;
} }
/** /*
* insert_extent - Safely insert a new idmap extent into struct uid_gid_map. * insert_extent - Safely insert a new idmap extent into struct uid_gid_map.
* Takes care to allocate a 4K block of memory if the number of mappings exceeds * Takes care to allocate a 4K block of memory if the number of mappings exceeds
* UID_GID_MAP_MAX_BASE_EXTENTS. * UID_GID_MAP_MAX_BASE_EXTENTS.
@ -839,7 +839,7 @@ static int cmp_extents_reverse(const void *a, const void *b)
return 0; return 0;
} }
/** /*
* sort_idmaps - Sorts an array of idmap entries. * sort_idmaps - Sorts an array of idmap entries.
* Can only be called if number of mappings exceeds UID_GID_MAP_MAX_BASE_EXTENTS. * Can only be called if number of mappings exceeds UID_GID_MAP_MAX_BASE_EXTENTS.
*/ */