netdev - Re: [PATCH net] docs: networking: add full DIM API

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <ee8a06a5-06fd-4d97-193c-51cc3ad41e7e@infradead.org>
Date:   Thu, 9 Apr 2020 13:25:51 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Jakub Kicinski <kuba@...nel.org>
Cc:     davem@...emloft.net, netdev@...r.kernel.org, kernel-team@...com,
        talgi@...lanox.com, leon@...nel.org, jacob.e.keller@...el.com
Subject: Re: [PATCH net] docs: networking: add full DIM API

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@...radead.org>
>>>>
>>>> Add the full net DIM API to the net_dim.rst file.
>>>>
>>>> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
>>>> Cc: davem@...emloft.net
>>>> Cc: Jakub Kicinski <kuba@...nel.org>
>>>> Cc: netdev@...r.kernel.org, talgi@...lanox.com, leon@...nel.org, jacob.e.keller@...el.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.
-- 
~Randy