Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.37 as permitted sender) client-ip=23.128.96.37;
Message-ID: <569119a8-f6f2-4e00-bfcc-5b804447320f@redhat.com>
Date:   Mon, 20 Nov 2023 22:04:24 -0500
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
Subject: Re: kernel/cgroup/debug.c:1: warning: no structured comments found
To:     kernel test robot <lkp@intel.com>
Cc:     oe-kbuild-all@lists.linux.dev, linux-kernel@vger.kernel.org,
        Tejun Heo <tj@kernel.org>
References: <202311211005.Qwt1FHrO-lkp@intel.com>
Content-Language: en-US
From:   Waiman Long <longman@redhat.com>
In-Reply-To: <202311211005.Qwt1FHrO-lkp@intel.com>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
Precedence: bulk


On 11/20/23 21:32, kernel test robot wrote:
> tree:   https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
> head:   98b1cc82c4affc16f5598d4fa14b1858671b2263
> commit: a28f8f5e995fe5964ae304444913536058f26e37 cgroup: Move debug cgroup to its own file
> date:   6 years ago
> config: i386-buildonly-randconfig-005-20231120 (https://download.01.org/0day-ci/archive/20231121/202311211005.Qwt1FHrO-lkp@intel.com/config)
> compiler: gcc-7 (Ubuntu 7.5.0-6ubuntu2) 7.5.0
> reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20231121/202311211005.Qwt1FHrO-lkp@intel.com/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@intel.com>
> | Closes: https://lore.kernel.org/oe-kbuild-all/202311211005.Qwt1FHrO-lkp@intel.com/
>
> All warnings (new ones prefixed by >>):
>
>>> kernel/cgroup/debug.c:1: warning: no structured comments found
>
> vim +1 kernel/cgroup/debug.c
>
>     > 1	#include <linux/ctype.h>
>       2	#include <linux/mm.h>
>       3	#include <linux/slab.h>
>       4	

Yes, there is no function in this file with structure comments. This 
debug controller is used for debugging only and is not supposed to be 
used on production systems anyway. Its interface is unstable and so I 
don't see a need to properly document its interface.

I will leave this file as it is for now.

Cheers,
Longman