[00/12] infiniband kernel-doc fixes & driver-api/ chapter
mbox series

Message ID 20191010035239.532908118@gmail.com
Headers show
Series
  • infiniband kernel-doc fixes & driver-api/ chapter
Related show

Message

Randy Dunlap Oct. 10, 2019, 3:52 a.m. UTC
This patch series cleans up lots of kernel-doc in drivers/infiniband/
and then adds an infiniband.rst file.

It also changes a few instances of non-exported functions from kernel-doc
notation back to non-kernel-doc comments.

There are still a few kernel-doc and Sphinx warnings that I don't know how
to resolve:

  ../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'
  ../drivers/infiniband/core/verbs.c:2510: WARNING: Unexpected indentation.
  ../drivers/infiniband/core/verbs.c:2512: WARNING: Block quote ends without a blank line; unexpected unindent.
  ../drivers/infiniband/core/verbs.c:2544: WARNING: Unexpected indentation.

I have not added any Fixes: tags to these patches because I don't
think that they need to be applied to any stable releases...


 Documentation/driver-api/index.rst                  |    1 
 Documentation/driver-api/infiniband.rst             |  127 ++++++++++
 drivers/infiniband/core/device.c                    |   23 -
 drivers/infiniband/core/iwpm_util.h                 |    5 
 drivers/infiniband/core/sa_query.c                  |    2 
 drivers/infiniband/core/verbs.c                     |    2 
 drivers/infiniband/sw/rdmavt/ah.c                   |    1 
 drivers/infiniband/sw/rdmavt/cq.c                   |    2 
 drivers/infiniband/sw/rdmavt/qp.c                   |   30 +-
 drivers/infiniband/sw/rdmavt/vt.c                   |    3 
 drivers/infiniband/ulp/iser/iscsi_iser.c            |    2 
 drivers/infiniband/ulp/iser/iscsi_iser.h            |   26 +-
 drivers/infiniband/ulp/iser/iser_initiator.c        |    5 
 drivers/infiniband/ulp/iser/iser_verbs.c            |   60 ++--
 drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h    |   42 +++
 drivers/infiniband/ulp/opa_vnic/opa_vnic_internal.h |    8 
 drivers/infiniband/ulp/srpt/ib_srpt.h               |    7 
 17 files changed, 269 insertions(+), 77 deletions(-)

Comments

Jason Gunthorpe Oct. 22, 2019, 6:41 p.m. UTC | #1
On Wed, Oct 09, 2019 at 08:52:39PM -0700, rd.dunlab@gmail.com wrote:
> 
> This patch series cleans up lots of kernel-doc in drivers/infiniband/
> and then adds an infiniband.rst file.
> 
> It also changes a few instances of non-exported functions from kernel-doc
> notation back to non-kernel-doc comments.
> 
> There are still a few kernel-doc and Sphinx warnings that I don't know how
> to resolve:
> 
>   ../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'

Maybe Max can help?

>   ../drivers/infiniband/core/verbs.c:2510: WARNING: Unexpected indentation.
>   ../drivers/infiniband/core/verbs.c:2512: WARNING: Block quote ends without a blank line; unexpected unindent.
>   ../drivers/infiniband/core/verbs.c:2544: WARNING: Unexpected indentation.

I don't know what to make of these either.

Anyhow, it is an overall improvement, so I applied everything but

[05/12] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h kernel-doc notation

pending some discussion.

Thanks,
Jason
Max Gurtovoy Oct. 22, 2019, 10:51 p.m. UTC | #2
On 10/22/2019 9:41 PM, Jason Gunthorpe wrote:
> On Wed, Oct 09, 2019 at 08:52:39PM -0700, rd.dunlab@gmail.com wrote:
>> This patch series cleans up lots of kernel-doc in drivers/infiniband/
>> and then adds an infiniband.rst file.
>>
>> It also changes a few instances of non-exported functions from kernel-doc
>> notation back to non-kernel-doc comments.
>>
>> There are still a few kernel-doc and Sphinx warnings that I don't know how
>> to resolve:
>>
>>    ../drivers/infiniband/ulp/iser/iscsi_iser.h:401: warning: Function parameter or member 'all_list' not described in 'iser_fr_desc'

@all_list:           entry in the entire fastreg descriptors list

or

@all_list:           entry in the whole fastreg descriptors list

>>    ../drivers/infiniband/ulp/iser/iscsi_iser.h:415: warning: Function parameter or member 'all_list' not described in 'iser_fr_pool'
@all_list:                list of all fastreg descriptors for the connection
> Maybe Max can help?
>
>>    ../drivers/infiniband/core/verbs.c:2510: WARNING: Unexpected indentation.
>>    ../drivers/infiniband/core/verbs.c:2512: WARNING: Block quote ends without a blank line; unexpected unindent.
>>    ../drivers/infiniband/core/verbs.c:2544: WARNING: Unexpected indentation.
> I don't know what to make of these either.
>
> Anyhow, it is an overall improvement, so I applied everything but
>
> [05/12] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h kernel-doc notation
>
> pending some discussion.
>
> Thanks,
> Jason
Dennis Dalessandro Oct. 23, 2019, 11:54 a.m. UTC | #3
On 10/22/2019 2:41 PM, Jason Gunthorpe wrote:
> On Wed, Oct 09, 2019 at 08:52:39PM -0700, rd.dunlab@gmail.com wrote:
>>
>> This patch series cleans up lots of kernel-doc in drivers/infiniband/
>> and then adds an infiniband.rst file.
>>
>> It also changes a few instances of non-exported functions from kernel-doc
>> notation back to non-kernel-doc comments.
>>
>> There are still a few kernel-doc and Sphinx warnings that I don't know how
>> to resolve:
>>
>>    ../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'
> 
> Maybe Max can help?
> 
>>    ../drivers/infiniband/core/verbs.c:2510: WARNING: Unexpected indentation.
>>    ../drivers/infiniband/core/verbs.c:2512: WARNING: Block quote ends without a blank line; unexpected unindent.
>>    ../drivers/infiniband/core/verbs.c:2544: WARNING: Unexpected indentation.
> 
> I don't know what to make of these either.
> 
> Anyhow, it is an overall improvement, so I applied everything but
> 
> [05/12] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h kernel-doc notation

Safe to assume the kbuild robot failure [1] is a result of this?

[1] https://marc.info/?l=linux-rdma&m=157177785916141&w=2

-Denny
Jason Gunthorpe Oct. 23, 2019, 2:39 p.m. UTC | #4
On Wed, Oct 23, 2019 at 07:54:46AM -0400, Dennis Dalessandro wrote:
> On 10/22/2019 2:41 PM, Jason Gunthorpe wrote:
> > On Wed, Oct 09, 2019 at 08:52:39PM -0700, rd.dunlab@gmail.com wrote:
> > > 
> > > This patch series cleans up lots of kernel-doc in drivers/infiniband/
> > > and then adds an infiniband.rst file.
> > > 
> > > It also changes a few instances of non-exported functions from kernel-doc
> > > notation back to non-kernel-doc comments.
> > > 
> > > There are still a few kernel-doc and Sphinx warnings that I don't know how
> > > to resolve:
> > > 
> > >    ../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'
> > 
> > Maybe Max can help?
> > 
> > >    ../drivers/infiniband/core/verbs.c:2510: WARNING: Unexpected indentation.
> > >    ../drivers/infiniband/core/verbs.c:2512: WARNING: Block quote ends without a blank line; unexpected unindent.
> > >    ../drivers/infiniband/core/verbs.c:2544: WARNING: Unexpected indentation.
> > 
> > I don't know what to make of these either.
> > 
> > Anyhow, it is an overall improvement, so I applied everything but
> > 
> > [05/12] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h kernel-doc notation
> 
> Safe to assume the kbuild robot failure [1] is a result of this?
> 
> [1] https://marc.info/?l=linux-rdma&m=157177785916141&w=2

Yes, just more warnings

Jason