Linux-RDMA Archive on lore.kernel.org
 help / color / Atom feed
* [PATCH] Documentation: networking: add a chapter for the DIM library
@ 2019-10-10 22:55 Randy Dunlap
  2019-10-10 23:20 ` Jakub Kicinski
  0 siblings, 1 reply; 6+ messages in thread
From: Randy Dunlap @ 2019-10-10 22:55 UTC (permalink / raw)
  To: netdev, linux-rdma; +Cc: Tal Gilboa, David Miller, Jakub Kicinski

From: Randy Dunlap <rdunlap@infradead.org>

Add a Documentation networking chapter for the DIM library.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Tal Gilboa <talgi@mellanox.com>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Jakub Kicinski <jakub.kicinski@netronome.com>
Cc: netdev@vger.kernel.org
Cc: linux-rdma@vger.kernel.org
---
 Documentation/networking/index.rst   |    1 +
 Documentation/networking/lib-dim.rst |    6 ++++++
 2 files changed, 7 insertions(+)

--- linux-next-20191010.orig/Documentation/networking/index.rst
+++ linux-next-20191010/Documentation/networking/index.rst
@@ -33,6 +33,7 @@ Contents:
    scaling
    tls
    tls-offload
+   lib-dim
 
 .. only::  subproject and html
 
--- /dev/null
+++ linux-next-20191010/Documentation/networking/lib-dim.rst
@@ -0,0 +1,6 @@
+=====================================================
+Dynamic Interrupt Moderation (DIM) library interfaces
+=====================================================
+
+.. kernel-doc:: include/linux/dim.h
+    :internal:



^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] Documentation: networking: add a chapter for the DIM library
  2019-10-10 22:55 [PATCH] Documentation: networking: add a chapter for the DIM library Randy Dunlap
@ 2019-10-10 23:20 ` Jakub Kicinski
  2019-10-10 23:34   ` Randy Dunlap
  0 siblings, 1 reply; 6+ messages in thread
From: Jakub Kicinski @ 2019-10-10 23:20 UTC (permalink / raw)
  To: Randy Dunlap
  Cc: netdev, linux-rdma, Tal Gilboa, David Miller, linux-doc, Jacob Keller

On Thu, 10 Oct 2019 15:55:15 -0700, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@infradead.org>
> 
> Add a Documentation networking chapter for the DIM library.
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Tal Gilboa <talgi@mellanox.com>
> Cc: "David S. Miller" <davem@davemloft.net>
> Cc: Jakub Kicinski <jakub.kicinski@netronome.com>
> Cc: netdev@vger.kernel.org
> Cc: linux-rdma@vger.kernel.org
> ---
>  Documentation/networking/index.rst   |    1 +
>  Documentation/networking/lib-dim.rst |    6 ++++++
>  2 files changed, 7 insertions(+)
> 
> --- linux-next-20191010.orig/Documentation/networking/index.rst
> +++ linux-next-20191010/Documentation/networking/index.rst
> @@ -33,6 +33,7 @@ Contents:
>     scaling
>     tls
>     tls-offload
> +   lib-dim
>  
>  .. only::  subproject and html
>  
> --- /dev/null
> +++ linux-next-20191010/Documentation/networking/lib-dim.rst
> @@ -0,0 +1,6 @@
> +=====================================================
> +Dynamic Interrupt Moderation (DIM) library interfaces
> +=====================================================
> +
> +.. kernel-doc:: include/linux/dim.h
> +    :internal:
> 
> 

CC: linux-doc, Jake

How does this relate to Documentation/networking/net_dim.txt ?
(note in case you want to edit that one there is a patch with 
updates for that file from Jake I'll be applying shortly)

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] Documentation: networking: add a chapter for the DIM library
  2019-10-10 23:20 ` Jakub Kicinski
@ 2019-10-10 23:34   ` Randy Dunlap
  2019-10-10 23:58     ` Jakub Kicinski
  0 siblings, 1 reply; 6+ messages in thread
From: Randy Dunlap @ 2019-10-10 23:34 UTC (permalink / raw)
  To: Jakub Kicinski
  Cc: netdev, linux-rdma, Tal Gilboa, David Miller, linux-doc, Jacob Keller

On 10/10/19 4:20 PM, Jakub Kicinski wrote:
> On Thu, 10 Oct 2019 15:55:15 -0700, Randy Dunlap wrote:
>> From: Randy Dunlap <rdunlap@infradead.org>
>>
>> Add a Documentation networking chapter for the DIM library.
>>
>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>> Cc: Tal Gilboa <talgi@mellanox.com>
>> Cc: "David S. Miller" <davem@davemloft.net>
>> Cc: Jakub Kicinski <jakub.kicinski@netronome.com>
>> Cc: netdev@vger.kernel.org
>> Cc: linux-rdma@vger.kernel.org
>> ---
>>  Documentation/networking/index.rst   |    1 +
>>  Documentation/networking/lib-dim.rst |    6 ++++++
>>  2 files changed, 7 insertions(+)
>>
>> --- linux-next-20191010.orig/Documentation/networking/index.rst
>> +++ linux-next-20191010/Documentation/networking/index.rst
>> @@ -33,6 +33,7 @@ Contents:
>>     scaling
>>     tls
>>     tls-offload
>> +   lib-dim
>>  
>>  .. only::  subproject and html
>>  
>> --- /dev/null
>> +++ linux-next-20191010/Documentation/networking/lib-dim.rst
>> @@ -0,0 +1,6 @@
>> +=====================================================
>> +Dynamic Interrupt Moderation (DIM) library interfaces
>> +=====================================================
>> +
>> +.. kernel-doc:: include/linux/dim.h
>> +    :internal:
>>
>>
> 
> CC: linux-doc, Jake
> 
> How does this relate to Documentation/networking/net_dim.txt ?
> (note in case you want to edit that one there is a patch with 
> updates for that file from Jake I'll be applying shortly)
> 

There is also a small patch from Jesse:
https://lore.kernel.org/netdev/20191010193112.15215-1-jesse.brandeburg@intel.com/


-- 
~Randy

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] Documentation: networking: add a chapter for the DIM library
  2019-10-10 23:34   ` Randy Dunlap
@ 2019-10-10 23:58     ` Jakub Kicinski
  2019-10-11  0:01       ` Randy Dunlap
  0 siblings, 1 reply; 6+ messages in thread
From: Jakub Kicinski @ 2019-10-10 23:58 UTC (permalink / raw)
  To: Randy Dunlap
  Cc: netdev, linux-rdma, Tal Gilboa, David Miller, linux-doc, Jacob Keller

On Thu, 10 Oct 2019 16:34:59 -0700, Randy Dunlap wrote:
> On 10/10/19 4:20 PM, Jakub Kicinski wrote:
> > On Thu, 10 Oct 2019 15:55:15 -0700, Randy Dunlap wrote:  
> >> From: Randy Dunlap <rdunlap@infradead.org>
> >>
> >> Add a Documentation networking chapter for the DIM library.
> >>
> >> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> >> Cc: Tal Gilboa <talgi@mellanox.com>
> >> Cc: "David S. Miller" <davem@davemloft.net>
> >> Cc: Jakub Kicinski <jakub.kicinski@netronome.com>
> >> Cc: netdev@vger.kernel.org
> >> Cc: linux-rdma@vger.kernel.org
> >> ---
> >>  Documentation/networking/index.rst   |    1 +
> >>  Documentation/networking/lib-dim.rst |    6 ++++++
> >>  2 files changed, 7 insertions(+)
> >>
> >> --- linux-next-20191010.orig/Documentation/networking/index.rst
> >> +++ linux-next-20191010/Documentation/networking/index.rst
> >> @@ -33,6 +33,7 @@ Contents:
> >>     scaling
> >>     tls
> >>     tls-offload
> >> +   lib-dim
> >>  
> >>  .. only::  subproject and html
> >>  
> >> --- /dev/null
> >> +++ linux-next-20191010/Documentation/networking/lib-dim.rst
> >> @@ -0,0 +1,6 @@
> >> +=====================================================
> >> +Dynamic Interrupt Moderation (DIM) library interfaces
> >> +=====================================================
> >> +
> >> +.. kernel-doc:: include/linux/dim.h
> >> +    :internal:
> >>
> >>  
> > 
> > CC: linux-doc, Jake
> > 
> > How does this relate to Documentation/networking/net_dim.txt ?
> > (note in case you want to edit that one there is a patch with 
> > updates for that file from Jake I'll be applying shortly)

Applied now.

> There is also a small patch from Jesse:
> https://lore.kernel.org/netdev/20191010193112.15215-1-jesse.brandeburg@intel.com/

Ack, as Jake said this duplicates part of what his patch covered, tho.

Will you try to convert and integrate the existing file instead, or do
you think the kdoc file should be separate?

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] Documentation: networking: add a chapter for the DIM library
  2019-10-10 23:58     ` Jakub Kicinski
@ 2019-10-11  0:01       ` Randy Dunlap
  2019-10-11  0:33         ` Jakub Kicinski
  0 siblings, 1 reply; 6+ messages in thread
From: Randy Dunlap @ 2019-10-11  0:01 UTC (permalink / raw)
  To: Jakub Kicinski
  Cc: netdev, linux-rdma, Tal Gilboa, David Miller, linux-doc, Jacob Keller

On 10/10/19 4:58 PM, Jakub Kicinski wrote:
> On Thu, 10 Oct 2019 16:34:59 -0700, Randy Dunlap wrote:
>> On 10/10/19 4:20 PM, Jakub Kicinski wrote:
>>> On Thu, 10 Oct 2019 15:55:15 -0700, Randy Dunlap wrote:  
>>>> From: Randy Dunlap <rdunlap@infradead.org>
>>>>
>>>> Add a Documentation networking chapter for the DIM library.
>>>>
>>>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>>>> Cc: Tal Gilboa <talgi@mellanox.com>
>>>> Cc: "David S. Miller" <davem@davemloft.net>
>>>> Cc: Jakub Kicinski <jakub.kicinski@netronome.com>
>>>> Cc: netdev@vger.kernel.org
>>>> Cc: linux-rdma@vger.kernel.org
>>>> ---
>>>>  Documentation/networking/index.rst   |    1 +
>>>>  Documentation/networking/lib-dim.rst |    6 ++++++
>>>>  2 files changed, 7 insertions(+)
>>>>
>>>> --- linux-next-20191010.orig/Documentation/networking/index.rst
>>>> +++ linux-next-20191010/Documentation/networking/index.rst
>>>> @@ -33,6 +33,7 @@ Contents:
>>>>     scaling
>>>>     tls
>>>>     tls-offload
>>>> +   lib-dim
>>>>  
>>>>  .. only::  subproject and html
>>>>  
>>>> --- /dev/null
>>>> +++ linux-next-20191010/Documentation/networking/lib-dim.rst
>>>> @@ -0,0 +1,6 @@
>>>> +=====================================================
>>>> +Dynamic Interrupt Moderation (DIM) library interfaces
>>>> +=====================================================
>>>> +
>>>> +.. kernel-doc:: include/linux/dim.h
>>>> +    :internal:
>>>>
>>>>  
>>>
>>> CC: linux-doc, Jake
>>>
>>> How does this relate to Documentation/networking/net_dim.txt ?
>>> (note in case you want to edit that one there is a patch with 
>>> updates for that file from Jake I'll be applying shortly)
> 
> Applied now.
> 
>> There is also a small patch from Jesse:
>> https://lore.kernel.org/netdev/20191010193112.15215-1-jesse.brandeburg@intel.com/
> 
> Ack, as Jake said this duplicates part of what his patch covered, tho.

Yes, so I noticed.

> Will you try to convert and integrate the existing file instead, or do
> you think the kdoc file should be separate?

I'll take a look at doing that.

thanks.
-- 
~Randy

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] Documentation: networking: add a chapter for the DIM library
  2019-10-11  0:01       ` Randy Dunlap
@ 2019-10-11  0:33         ` Jakub Kicinski
  0 siblings, 0 replies; 6+ messages in thread
From: Jakub Kicinski @ 2019-10-11  0:33 UTC (permalink / raw)
  To: Randy Dunlap
  Cc: netdev, linux-rdma, Tal Gilboa, David Miller, linux-doc, Jacob Keller

On Thu, 10 Oct 2019 17:01:02 -0700, Randy Dunlap wrote:
> > Will you try to convert and integrate the existing file instead, or do
> > you think the kdoc file should be separate?  
> 
> I'll take a look at doing that.

Thanks!

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, back to index

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-10-10 22:55 [PATCH] Documentation: networking: add a chapter for the DIM library Randy Dunlap
2019-10-10 23:20 ` Jakub Kicinski
2019-10-10 23:34   ` Randy Dunlap
2019-10-10 23:58     ` Jakub Kicinski
2019-10-11  0:01       ` Randy Dunlap
2019-10-11  0:33         ` Jakub Kicinski

Linux-RDMA Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-rdma/0 linux-rdma/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-rdma linux-rdma/ https://lore.kernel.org/linux-rdma \
		linux-rdma@vger.kernel.org
	public-inbox-index linux-rdma

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-rdma


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git