Linux Manual Pages development
 help / color / mirror / Atom feed
From: "Günther Noack" <gnoack3000@gmail.com>
To: Alejandro Colomar <alx@kernel.org>
Cc: Kuniyuki Iwashima <kuniyu@google.com>, linux-man@vger.kernel.org
Subject: Re: [PATCH v2 00/24] Documentation fixes in unix(7)
Date: Mon, 19 Oct 2026 10:48:00 +0200	[thread overview]
Message-ID: <20261019.e37ed940437d@gnoack.org> (raw)
In-Reply-To: <atW_3kqU7KMcxHXp@debian>

Hello Alejandro and Kuniyuki!

On Mon, Oct 19, 2026 at 09:05:21AM +0200, Alejandro Colomar wrote:
> > Date: 2026-10-18 11:37:16-0700
> > From: Kuniyuki Iwashima <kuniyu@google.com>
> > On Sun, Oct 18, 2026 at 10:37 AM Günther Noack <gnoack3000@gmail.com> wrote:
> > > Alejandro, I am sorry that you don't want to review this any further
> > > due to LLM use.
> > 
> > I understand the frustration since maintainers are getting
> > overwhelmed by too many AI slops these days (I'm not saying
> > this series is) and the review cost is way higher than before.
> > 
> > I'm happy to review this series as a AF_UNIX maintainer to
> > reduce Alejandro's cost, so please CC me on every patch, and
> > CC each author of (relatively) new functionality.
> 
> Thanks a lot!

Thanks from me as well, I will happily take you up on that offer.

Thanks to you as well Alejandro, for reconsidering in [1] and
continuing the review!

[1] https://lore.kernel.org/all/atW-XL6H72Nyy3N3@debian/


> > Also, please split the series into 3, general part (socket, bind,
> > protocol stuff, etc), socket diag part, and scm part (SCM_XXX,
> > SO_PASSXXX, etc).
> > 
> > It would be easier for us to review small series than a single
> > large series. (fwiw, netdev mailing list has ~15 patch limit)
> 
> I'm okay with a split.

I agree, it is admittedly a large number of patches that I sent here,
and I can understand that this is tedious.

I'll have a look in the next days and split this patch set up into
more digestible chunks.

> 
> [...]
> > > Some mentionworthy points about features that were missing or had out
> > > of date documentation:
> > >
> > > * Out of band messaging support (MSG_OOB):
> > 
> > Please drop these changes.  I planned to remove it in the next
> > cycle since recent AI-driven security research targets the poor
> > implementation, and even if the bug is trivial for the plain AF_UNIX,
> > MSG_OOB tends to promote it to UAF (and thus LPE) and risks
> > users for no good reason.

Yes, OK.  To be clear, the man page currently just says that OOB is
not supported for Unix Domain Sockets, and my plan was to remove that
wording (because it's technically wrong), but to refrain from
documenting it so that not even more people pick it up and so that
that doesn't get into the way of your deprecation efforts.  (It's in
commit 22/24.)

If you are saying that the deprecation is close enough, I'll just
leave it as is then, so that it keeps saying OOB is not supported.


> > > [1] https://lore.kernel.org/all/bef45d8e-35b7-42e4-bf6c-768da5b6d8f2@oracle.com/
> > > [2] https://projectzero.google/2025/08/from-chrome-renderer-code-exec-to-kernel.html
> > >
> > > Günther Noack (24):
> > >   man/man7/unix.7: ERRORS: EINVAL: The address field is sun_family, not
> > >     sun_type
> > 
> > Correct the address field s/sun_family/sun_type/
> 
> I think you meant s/sun_type/sun_family/?
> 
> > It seems the subjects are not formatted well, which makes me
> > feel AI cannot follow the standard and it is not worth reviewing :/
> 
> The subjects seem okay to me.  In the man-pages, we use slightly
> different conventions than in the kernel, so I guess that's why it seems
> strange to you.  :)
> 
> > 
> > >   man/man7/unix.7: Socket options: SOL_SOCKET is a level, not a family
> > 
> > Describe SOL_SOCKET as socket level, not family
> 
> To my own understanding, I'll ask: technically, SOL_SOCKET (like any
> SOL_*) is a protocol level.  The socket level is just one of the many
> protocol levels, right?

In my interpretation (but this is also only gathered from the
setsockopt(2) man page), the "level" option to setsockopt() and
getsockopt() acts as a "namespace" for the actual option value, so
that the unrelated socket options that are specific to the protocols
don't all need to use the same enum space?

I skimmed through Steven's "UNIX Network Programming Volume 1: The
Sockets Networking API" looking for mentions of "level", but the only
places where I found it was for getsockopt()/setsockopt() and in
struct cmsghdr (see cmsg(3)), where it is also used to qualify a
similar enum.

About the getsockopt()/setsockopt() use, the book says:

  "level" specifies the code in the system that interprets the option:
  the general socket code or some protocol-specific code (e.g., IPv4,
  IPv6, TCP, or SCTP).

As valid level values that can be passed, the book lists SOL_SOCKET,
IPPROTO_IP, IPPROTO_ICMPV6, IPPROTO_IPV6, IPPROTO_TCP and
IPPROTO_SCTP.


In any case, in the commit here, we are replacing a mention of

  "...can be read with [...] getsockopt(2) by specifying SOL_SOCKET as
  the socket family"

with:

  "...can be read with [...] getsockopt(2) by specifying SOL_SOCKET as
  the level"

Independent of the exact terminology, that is still a good change to
do because it identifies the name of the getsockopt(2) argument, which
is "level".  (There are also some values which can be passed as level
which correspond to socket families in the sense of socket(2), but
SOL_SOCKET is not one of them.)

> > >   man/man7/unix.7: SO_PASSCRED: ffix
> > 
> > ??  This reminds me of Final Fantasy IX :p
> > 
> > Please fix all of them.
> 
> We use 'ffix' as a shorthand for 'formatting fix'.  Those patches
> usually make something bold, or remove bold, but don't do anything
> meaningful to the page.

Hah, yes. :)  As documented in CONTRIBUTING.d/patches/subject

Computer game references are unintended. ;-)

–Günther

  reply	other threads:[~2026-10-19  8:48 UTC|newest]

Thread overview: 29+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-10-18 17:36 [PATCH v2 00/24] Documentation fixes in unix(7) Günther Noack
2026-10-18 17:36 ` [PATCH v2 01/24] man/man7/unix.7: ERRORS: EINVAL: The address field is sun_family, not sun_type Günther Noack
2026-10-18 17:36 ` [PATCH v2 02/24] man/man7/unix.7: Socket options: SOL_SOCKET is a level, not a family Günther Noack
2026-10-18 17:36 ` [PATCH v2 03/24] man/man7/unix.7: SO_PASSCRED: ffix Günther Noack
2026-10-18 17:36 ` [PATCH v2 04/24] man/man7/sock_diag.7: Fix member order of struct unix_diag_vfs Günther Noack
2026-10-18 17:36 ` [PATCH v2 05/24] man/man7/sock_diag.7: udiag_wqueue: This is memory in use, not memory available Günther Noack
2026-10-18 17:36 ` [PATCH v2 06/24] man/man7/unix.7: ERRORS: EPROTONOSUPPORT: Protocol 0 is also accepted Günther Noack
2026-10-18 17:36 ` [PATCH v2 07/24] man/man7/unix.7: ERRORS: ETOOMANYREFS: Fix the conditions Günther Noack
2026-10-18 17:36 ` [PATCH v2 08/24] man/man7/socket.7: SO_PEEK_OFF: This option is no longer specific to unix(7) Günther Noack
2026-10-18 17:36 ` [PATCH v2 09/24] man/man7/unix.7: SO_PEERCRED: Also works for SOCK_SEQPACKET Günther Noack
2026-10-18 17:36 ` [PATCH v2 10/24] man/man7/unix.7: SIOCINQ: Document behavior " Günther Noack
2026-10-18 17:36 ` [PATCH v2 11/24] man/man7/sock_diag.7: udiag_states: Document TCP_CLOSE Günther Noack
2026-10-18 17:37 ` [PATCH v2 12/24] man/man7/sock_diag.7: UNIX_DIAG_NAME: The payload is not always a pathname Günther Noack
2026-10-18 17:37 ` [PATCH v2 13/24] man/man7/sock_diag.7: Document UDIAG_SHOW_UID Günther Noack
2026-10-18 17:37 ` [PATCH v2 14/24] man/man7/unix.7: Several items of the same type may be sent in one message Günther Noack
2026-10-18 17:37 ` [PATCH v2 15/24] man/man2/bind.2: ERRORS: EACCES: Write permission on the directory is required Günther Noack
2026-10-18 17:37 ` [PATCH v2 16/24] man/man7/unix.7: Autobind: Fix when it happens, and mention SO_PASSPIDFD Günther Noack
2026-10-18 17:37 ` [PATCH v2 17/24] man/man7/unix.7: SOCK_RAW is accepted as an alias for SOCK_DGRAM Günther Noack
2026-10-18 17:37 ` [PATCH v2 18/24] man/man7/unix.7: SCM_SECURITY: This is not specific to SELinux Günther Noack
2026-10-18 17:37 ` [PATCH v2 19/24] man/man7/unix.7: SO_PASSSEC: wfix Günther Noack
2026-10-18 17:37 ` [PATCH v2 20/24] man/man7/unix.7: ERRORS: Document EACCES, EAGAIN, EMSGSIZE, ENOSPC, and EPERM Günther Noack
2026-10-18 17:37 ` [PATCH v2 21/24] man/man7/unix.7: Abstract sockets are scoped to a network namespace Günther Noack
2026-10-18 17:37 ` [PATCH v2 22/24] man/man7/unix.7: Remove mentions of unsupported out-of-band messaging Günther Noack
2026-10-18 17:37 ` [PATCH v2 23/24] man/man7/unix.7: Document SO_PASSPIDFD, SO_PEERPIDFD, and SCM_PIDFD Günther Noack
2026-10-18 17:37 ` [PATCH v2 24/24] man/man7/unix.7: Document SO_PASSRIGHTS Günther Noack
2026-10-18 18:37 ` [PATCH v2 00/24] Documentation fixes in unix(7) Kuniyuki Iwashima
2026-10-19  7:05   ` Alejandro Colomar
2026-10-19  8:48     ` Günther Noack [this message]
2026-10-19 12:07     ` the meaning of "ffix" (was: [PATCH v2 00/24] Documentation fixes in unix(7)) G. Branden Robinson

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=20261019.e37ed940437d@gnoack.org \
    --to=gnoack3000@gmail.com \
    --cc=alx@kernel.org \
    --cc=kuniyu@google.com \
    --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