linux-api.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Jakub Głogowski" <not@dzwdz.net>
To: Alejandro Colomar <alx@kernel.org>
Cc: "Jakub Głogowski" <not@dzwdz.net>,
	linux-man@vger.kernel.org, LKML <linux-kernel@vger.kernel.org>,
	"Linux API" <linux-api@vger.kernel.org>,
	ej@inai.de
Subject: [PATCH 0/2] man7/ip.7: Clarify PKTINFO's docs
Date: Fri, 14 Nov 2025 15:29:29 +0100	[thread overview]
Message-ID: <cover.1763130571.git.not@dzwdz.net> (raw)

I found the PKTINFO docs pretty confusing, so I tried clarifying them:
- being more specific about each field in the struct
  (e.g. "local address of the packet" for a received packet could've
  been interpreted in myriad ways),
- making the differences between sendmsg(2)'s and recvmsg(2)'s handling
  of that struct more explicit,
- and some other slight rewording to make it (IMO) more readable - I cut
  out most of a paragraph that wasn't really saying anything, etc.

I'm not sure if this should even be documented in ip(7) together with
the other sockopts, though?  sendmsg(2)'s handling of in_pktinfo is
completely unrelated to the IP_PKTINFO sockopt.  Documenting it in its
own manual page would also give us more room for subsection headings and
other formatting, examples, etc - instead of trying to cram it into
what's already an enormous manpage.

Same goes for some of the other more complex sockopts, I guess.


PS. sorry for not signing this email, but neomutt didn't want to
cooperate :/  I'll try to figure it out for any followup patches.


Jakub Głogowski (2):
  man/man7/ip.7: Clarify PKTINFO's semantics depending on packet
    direction
  man/man7/ip.7: Reword IP_PKTINFO's description

 man/man7/ip.7 | 57 +++++++++++++++++++++++++++------------------------
 1 file changed, 30 insertions(+), 27 deletions(-)

-- 
2.47.3


             reply	other threads:[~2025-11-14 14:57 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-14 14:29 Jakub Głogowski [this message]
2025-11-14 14:29 ` [PATCH 1/2] man/man7/ip.7: Clarify PKTINFO's semantics depending on packet direction Jakub Głogowski
2025-11-18 14:31   ` Alejandro Colomar
2025-11-14 14:29 ` [PATCH 2/2] man/man7/ip.7: Reword IP_PKTINFO's description Jakub Głogowski
2025-11-18 13:51 ` [PATCH 0/2] man7/ip.7: Clarify PKTINFO's docs Alejandro Colomar

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=cover.1763130571.git.not@dzwdz.net \
    --to=not@dzwdz.net \
    --cc=alx@kernel.org \
    --cc=ej@inai.de \
    --cc=linux-api@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-man@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).