RE: [PATCH bpf-next v5 1/1] docs: BPF_MAP_TYPE_SOCK[MAP|HASH]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Maryam Tahhan <mtahhan@xxxxxxxxxx>  writes:
>> +.. note::
>> +    For more details of the socket callbacks that get replaced please see
>> +    ``net/ipv4/tcp_bpf.c`` and ``net/ipv4/udp_bpf.c`` for TCP and UDP
>> +    functions, respectively.
>>
>> Why this note?  The rest of the text looks to be usable cross-platform
>> but the note above implies that this documentation is lacking and the reader
>> has to consult the Linux source code.  Can more be documented
>> in the doc instead of just in the code?
> 
> The note is just a pointer to where folks can find these functions easily. I see
> lots of places in documentation where we make notes like these. Those files are 
> essentially the callback implementations, unless we think we need to document
> each 
> callback here (which for me seems like overkill for the map documentation), I can
> either remove the note or make it seem more like a pointer?

I have no preference, but my intent is that eventually cross-platform map types
will be added to standard documentation and that documentation won't have
such a note but would need to incorporate anything that's really cross-platform into the documentation itself.   Since most socket calls are POSIX standard APIs,
any callbacks that can be described by referencing such standard APIs could be
listed in cross-platform docs.

Dave 





[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux