| Message ID | 20191010035239.532908118@gmail.com (mailing list archive) |
|---|---|
| Headers | show |
| Series | infiniband kernel-doc fixes & driver-api/ chapter | expand |
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
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
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
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