netdev - Re: [PATCH man-pages] man: packet.7: document fanout, ring and auxiliary options

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: <CAKgNAkj8G6VvPLYF56884XcAWw+yOTUcF1UZSRwcYTk52D--zg@mail.gmail.com>
Date:	Sun, 5 Jan 2014 10:57:28 +1300
From:	"Michael Kerrisk (man-pages)" <mtk.manpages@...il.com>
To:	Daniel Borkmann <dborkman@...hat.com>
Cc:	Willem de Bruijn <willemb@...gle.com>,
	linux-man <linux-man@...r.kernel.org>,
	netdev <netdev@...r.kernel.org>,
	David Miller <davem@...emloft.net>
Subject: Re: [PATCH man-pages] man: packet.7: document fanout, ring and
 auxiliary options

Hello Daniel, and Willem,

On Sun, Jan 5, 2014 at 3:47 AM, Daniel Borkmann <dborkman@...hat.com> wrote:
> On 12/06/2013 08:54 PM, Daniel Borkmann wrote:
>>
>> On 12/06/2013 06:18 PM, Willem de Bruijn wrote:
>>>
>>> The packet socket manual page does not list all socket options.
>>>
>>> This patch adds descriptions of the common packet socket options
>>>    PACKET_AUXDATA, PACKET_FANOUT, PACKET_RX_RING, PACKET_STATISTICS,
>>>    PACKET_TX_RING
>>>
>>> and the ring-specific options
>>>    PACKET_LOSS, PACKET_RESERVE, PACKET_TIMESTAMP, PACKET_VERSION
>>>
>>> It does not yet add descriptions for
>>>    PACKET_COPY_THRESH, PACKET_HDRLEN, PACKET_ORIGDEV,
>>>    PACKET_TX_HAS_OFF, PACKET_TX_TIMESTAMP, PACKET_VNET_HDR
>>>
>>> It tries to balance being informative with exposing kernel detail
>>> that is unlikely to be used by most readers or that may change
>>> frequently. For implementation details, the manpage points to the
>>> documentation in kernel Documentation/networking. Let me know if
>>> options should be added or removed.
>>>
>>> Source: PACKET_FANOUT, PACKET_RX_RING and PACKET_VERSION are in
>>> /tools/testing/net/psock_fanout.c in the latest Linux kernel source
>>> tree. PACKET_STATISTICS was in the first version of that test.
>>> PACKET_TX_RING I have used elsewhere. The other options are based
>>> on reading kernel code.
>>>
>>>   [Very minor fixups. -dborkman]
>>>
>>> Signed-off-by: Willem de Bruijn <willemb@...gle.com>
>>
>>
>> Acked-by: Daniel Borkmann <dborkman@...hat.com>
>>
>> I went over the man page again, and it looks good to me.
>>
>> Great work and thanks for following up Willem!
>
>
> Ping, Michael, any progress on this one? Lets not get this work
> lost somewhere as it happened in March last year ...

Thanks for the ping, and sorry for the delay. I've applied the patch:
http://git.kernel.org/cgit/docs/man-pages/man-pages.git/commit/?id=dbb4f7516b22663da977ea5c37691c5940bb3eb7

I added kernel version numbers for two of the newly documented
options. You may want to check them:
http://git.kernel.org/cgit/docs/man-pages/man-pages.git/commit/?id=342639d9e9d766b7b3b3a03045144be64f1f556c

Cheers,

Michael

-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
--
To unsubscribe from this list: send the line "unsubscribe netdev" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html