| Message ID | e27192c8-a251-4d72-1102-85d250d50f49@infradead.org |
|---|---|
| State | Superseded |
| Delegated to: | David Miller |
| Headers | show |
| Series | [net] docs: networking: add full DIM API | expand |
On Thu, 9 Apr 2020 12:27:17 -0700 Randy Dunlap wrote: > From: Randy Dunlap <rdunlap@infradead.org> > > Add the full net DIM API to the net_dim.rst file. > > Signed-off-by: Randy Dunlap <rdunlap@infradead.org> > Cc: davem@davemloft.net > Cc: Jakub Kicinski <kuba@kernel.org> > Cc: netdev@vger.kernel.org, talgi@mellanox.com, leon@kernel.org, jacob.e.keller@intel.com Ah, very nice, I didn't know how to do that! Do you reckon we should drop the .. c:function and .. c:type marking I added? So that the mentions of net_dim and the structures point to the kdoc? Do you want to take best parts of both your and my versions and repost?
On 4/9/20 12:42 PM, Jakub Kicinski wrote: > On Thu, 9 Apr 2020 12:27:17 -0700 Randy Dunlap wrote: >> From: Randy Dunlap <rdunlap@infradead.org> >> >> Add the full net DIM API to the net_dim.rst file. >> >> Signed-off-by: Randy Dunlap <rdunlap@infradead.org> >> Cc: davem@davemloft.net >> Cc: Jakub Kicinski <kuba@kernel.org> >> Cc: netdev@vger.kernel.org, talgi@mellanox.com, leon@kernel.org, jacob.e.keller@intel.com > > Ah, very nice, I didn't know how to do that! > > Do you reckon we should drop the .. c:function and .. c:type marking I > added? So that the mentions of net_dim and the structures point to the > kdoc? My understanding is that if functions have an ending (), then the c:function is not needed/wanted. I don't know about the c:type uses. But there is some duplication that might be cleaned up some. > Do you want to take best parts of both your and my versions and repost? Not really. The part that was slowing me down is using git (for the removed file), and you have that part done. :) thanks.
On Thu, 9 Apr 2020 13:06:50 -0700 Randy Dunlap wrote: > On 4/9/20 12:42 PM, Jakub Kicinski wrote: > > On Thu, 9 Apr 2020 12:27:17 -0700 Randy Dunlap wrote: > >> From: Randy Dunlap <rdunlap@infradead.org> > >> > >> Add the full net DIM API to the net_dim.rst file. > >> > >> Signed-off-by: Randy Dunlap <rdunlap@infradead.org> > >> Cc: davem@davemloft.net > >> Cc: Jakub Kicinski <kuba@kernel.org> > >> Cc: netdev@vger.kernel.org, talgi@mellanox.com, leon@kernel.org, jacob.e.keller@intel.com > > > > Ah, very nice, I didn't know how to do that! > > > > Do you reckon we should drop the .. c:function and .. c:type marking I > > added? So that the mentions of net_dim and the structures point to the > > kdoc? > > My understanding is that if functions have an ending (), then the c:function > is not needed/wanted. I don't know about the c:type uses. > > But there is some duplication that might be cleaned up some. I think you're thinking about :c:func:, I was talking about .. c:function which basically renders very similar entries to kdoc. If you have the doc rendered check out what networking/net_dim.html#c.dim takes us to right now.
On 4/9/20 1:18 PM, Jakub Kicinski wrote: > On Thu, 9 Apr 2020 13:06:50 -0700 Randy Dunlap wrote: >> On 4/9/20 12:42 PM, Jakub Kicinski wrote: >>> On Thu, 9 Apr 2020 12:27:17 -0700 Randy Dunlap wrote: >>>> From: Randy Dunlap <rdunlap@infradead.org> >>>> >>>> Add the full net DIM API to the net_dim.rst file. >>>> >>>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org> >>>> Cc: davem@davemloft.net >>>> Cc: Jakub Kicinski <kuba@kernel.org> >>>> Cc: netdev@vger.kernel.org, talgi@mellanox.com, leon@kernel.org, jacob.e.keller@intel.com >>> >>> Ah, very nice, I didn't know how to do that! >>> >>> Do you reckon we should drop the .. c:function and .. c:type marking I >>> added? So that the mentions of net_dim and the structures point to the >>> kdoc? >> >> My understanding is that if functions have an ending (), then the c:function >> is not needed/wanted. I don't know about the c:type uses. >> >> But there is some duplication that might be cleaned up some. > > I think you're thinking about :c:func:, I was talking about .. > c:function which basically renders very similar entries to kdoc. Right. > If you have the doc rendered check out what > networking/net_dim.html#c.dim takes us to right now. OK, I see that. I don't object to those markings, but I would want to see the kernel-doc structs etc. thanks.
On Thu, 9 Apr 2020 13:25:51 -0700 Randy Dunlap wrote: > > If you have the doc rendered check out what > > networking/net_dim.html#c.dim takes us to right now. > > OK, I see that. > > I don't object to those markings, but I would want to see the kernel-doc > structs etc. Okay, I sent a v2 of my patch and included yours in the series just for ease of applying.
--- linux-next-20200409.orig/Documentation/networking/net_dim.rst +++ linux-next-20200409/Documentation/networking/net_dim.rst @@ -178,3 +178,9 @@ usage is not complete but it should make INIT_WORK(&my_entity->dim.work, my_driver_do_dim_work); ... } + +Dynamic Interrupt Moderation (DIM) library API +============================================== + +.. kernel-doc:: include/linux/dim.h + :internal: