Re: kernel/user_namespace.c:239: warning: Function parameter or member 'map_up' not described in 'idmap_key'

[Randy Dunlap]

On 8/30/23 01:24, Christian Brauner wrote:
> On Mon, Aug 28, 2023 at 10:13:06PM -0700, Randy Dunlap wrote:
>> Hi Christian,
>>
>> On 8/17/23 05:56, kernel test robot wrote:
>>> tree:   https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
>>> head:   4853c74bd7ab7fdb83f319bd9ace8a08c031e9b6
>>> commit: e227db4d4f125efb1cae2f1337da85bc10b3185e userns: fix a struct's kernel-doc notation
>>> date:   7 months ago
>>> config: parisc64-defconfig (https://download.01.org/0day-ci/archive/20230817/202308172003.O1QB7TgB-lkp@xxxxxxxxx/config)
>>> compiler: hppa64-linux-gcc (GCC) 12.3.0
>>> reproduce: (https://download.01.org/0day-ci/archive/20230817/202308172003.O1QB7TgB-lkp@xxxxxxxxx/reproduce)
>>>
>>> If you fix the issue in a separate patch/commit (i.e. not just a new version of
>>> the same patch/commit), kindly add following tags
>>> | Reported-by: kernel test robot <lkp@xxxxxxxxx>
>>> | Closes: https://lore.kernel.org/oe-kbuild-all/202308172003.O1QB7TgB-lkp@xxxxxxxxx/
>>>
>>> All warnings (new ones prefixed by >>):
>>>
>>>>> kernel/user_namespace.c:239: warning: Function parameter or member 'map_up' not described in 'idmap_key'
>>>>> kernel/user_namespace.c:239: warning: Function parameter or member 'id' not described in 'idmap_key'
>>>>> kernel/user_namespace.c:239: warning: Function parameter or member 'count' not described in 'idmap_key'
>>>    kernel/user_namespace.c:246: warning: Function parameter or member 'k' not described in 'cmp_map_id'
>>>    kernel/user_namespace.c:246: warning: Function parameter or member 'e' not described in 'cmp_map_id'
>>>    kernel/user_namespace.c:277: warning: Function parameter or member 'extents' not described in 'map_id_range_down_max'
>>>    kernel/user_namespace.c:277: warning: Function parameter or member 'map' not described in 'map_id_range_down_max'
>>>    kernel/user_namespace.c:277: warning: Function parameter or member 'id' not described in 'map_id_range_down_max'
>>>    kernel/user_namespace.c:277: warning: Function parameter or member 'count' not described in 'map_id_range_down_max'
>>>    kernel/user_namespace.c:295: warning: Function parameter or member 'extents' not described in 'map_id_range_down_base'
>>>    kernel/user_namespace.c:295: warning: Function parameter or member 'map' not described in 'map_id_range_down_base'
>>>    kernel/user_namespace.c:295: warning: Function parameter or member 'id' not described in 'map_id_range_down_base'
>>>    kernel/user_namespace.c:295: warning: Function parameter or member 'count' not described in 'map_id_range_down_base'
>>>    kernel/user_namespace.c:344: warning: Function parameter or member 'extents' not described in 'map_id_up_base'
>>>    kernel/user_namespace.c:344: warning: Function parameter or member 'map' not described in 'map_id_up_base'
>>>    kernel/user_namespace.c:344: warning: Function parameter or member 'id' not described in 'map_id_up_base'
>>>    kernel/user_namespace.c:364: warning: Function parameter or member 'extents' not described in 'map_id_up_max'
>>>    kernel/user_namespace.c:364: warning: Function parameter or member 'map' not described in 'map_id_up_max'
>>>    kernel/user_namespace.c:364: warning: Function parameter or member 'id' not described in 'map_id_up_max'
>>>    kernel/user_namespace.c:776: warning: Function parameter or member 'map' not described in 'insert_extent'
>>>    kernel/user_namespace.c:776: warning: Function parameter or member 'extent' not described in 'insert_extent'
>>>    kernel/user_namespace.c:844: warning: Function parameter or member 'map' not described in 'sort_idmaps'
>>>
>>
>> According to 'git blame', all of these come from additions that you made.
>>
>> What do you think about a patch that converts all of these into non-kernel-doc comments?
>> I.e., change "/**" to "/*" for the functions and struct?
> 
> Yeah, sure.

Hi Christian,

I sent a patch for this on 2023-AUG-30:

https://lore.kernel.org/all/20230830163215.13193-1-rdunlap@xxxxxxxxxxxxx/


-- 
~Randy