Re: [PATCH 12/12] infiniband: add a Documentation driver-api chapter for Infiniband

From: Randy Dunlap <rdunlap@infradead.org>
To: Jason Gunthorpe <jgg@ziepe.ca>, kbuild test robot <lkp@intel.com>
Cc: rd.dunlab@gmail.com, kbuild-all@01.org,
	linux-rdma@vger.kernel.org, Doug Ledford <dledford@redhat.com>,
	linux-doc@vger.kernel.org
Subject: Re: [PATCH 12/12] infiniband: add a Documentation driver-api chapter for Infiniband
Date: Mon, 21 Oct 2019 14:57:20 -0700	[thread overview]
Message-ID: <0525999e-8982-b0cf-8d98-a1f6c86fa148@infradead.org> (raw)
In-Reply-To: <20191021170745.GF25178@ziepe.ca>

On 10/21/19 10:07 AM, Jason Gunthorpe wrote:
> Randy,
> 
> What do you want to do with this series? Is this error below related
> needing respin, or just noise?
> 
> Thanks,
> Jason

Hi Jason,

I certainly would like to see patches 1-11 merged since they do lots of
cleanups/fixes that I prefer not to be lost.
If you don't want to merge patch 12, so be it.

My docs build has a total of 8 errors and 173 warnings, so I consider these
just more noise.  Please note that I am also working on cleaning up lots of
that noise.

Patches 3 and 7 mention new warnings that I am already aware of.

If you can tell me what the 'all_list' field [below] is/means,
I'll be glad to add a patch for that.

> On Thu, Oct 10, 2019 at 11:45:28PM +0800, kbuild test robot wrote:
>> Hi,
>>
>> Thank you for the patch! Perhaps something to improve:
>>
>> [auto build test WARNING on rdma/for-next]
>> [cannot apply to v5.4-rc2 next-20191010]
>> [if your patch is applied to the wrong git tree, please drop us a note to help
>> improve the system. BTW, we also suggest to use '--base' option to specify the
>> base tree in git format-patch, please see https://stackoverflow.com/a/37406982]
>>
>> url:    https://github.com/0day-ci/linux/commits/rd-dunlab-gmail-com/infiniband-kernel-doc-fixes-driver-api-chapter/20191010-220426
>> base:   https://git.kernel.org/pub/scm/linux/kernel/git/rdma/rdma.git for-next
>> reproduce: make htmldocs
>>
>> If you fix the issue, kindly add following tag
>> Reported-by: kbuild test robot <lkp@intel.com>
>>
>> All warnings (new ones prefixed by >>):
>>

[cutting non-related errors/warnings]

>>>> drivers/infiniband/ulp/iser/iscsi_iser.h:401: warning: Function parameter or member 'all_list' not described in 'iser_fr_desc'
>>>> drivers/infiniband/ulp/iser/iscsi_iser.h:415: warning: Function parameter or member 'all_list' not described in 'iser_fr_pool'
>>
>> vim +401 drivers/infiniband/ulp/iser/iscsi_iser.h
>>
>> 5587856c9659ac Sagi Grimberg       2013-07-28 @401  
>> 385ad87d4b637c Sagi Grimberg       2015-08-06  402  /**
>> e506e0f630a40d rd.dunlab@gmail.com 2019-10-09  403   * struct iser_fr_pool - connection fast registration pool
>> 385ad87d4b637c Sagi Grimberg       2015-08-06  404   *
>> 2b3bf958103899 Adir Lev            2015-08-06  405   * @list:                list of fastreg descriptors
>> 385ad87d4b637c Sagi Grimberg       2015-08-06  406   * @lock:                protects fmr/fastreg pool
>> 2b3bf958103899 Adir Lev            2015-08-06  407   * @size:                size of the pool
>> 385ad87d4b637c Sagi Grimberg       2015-08-06  408   */
>> 385ad87d4b637c Sagi Grimberg       2015-08-06  409  struct iser_fr_pool {
>> 2b3bf958103899 Adir Lev            2015-08-06  410  	struct list_head        list;
>> 385ad87d4b637c Sagi Grimberg       2015-08-06  411  	spinlock_t              lock;
>> 2b3bf958103899 Adir Lev            2015-08-06  412  	int                     size;
>> ea174c9573b0e0 Sagi Grimberg       2017-02-27  413  	struct list_head        all_list;
>> 385ad87d4b637c Sagi Grimberg       2015-08-06  414  };
>> 385ad87d4b637c Sagi Grimberg       2015-08-06 @415  
>>
>> :::::: The code at line 401 was first introduced by commit
>> :::::: 5587856c9659ac2d6ab201141aa8a5c2ff3be4cd IB/iser: Introduce fast memory registration model (FRWR)

thanks,
-- 
~Randy