All of lore.kernel.org
 help / color / mirror / Atom feed
From: Alexei Starovoitov <alexei.starovoitov@gmail.com>
To: "Alejandro Colomar (man-pages)" <alx.manpages@gmail.com>
Cc: bpf <bpf@vger.kernel.org>,
	"Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com>,
	linux-man <linux-man@vger.kernel.org>,
	LKML <linux-kernel@vger.kernel.org>,
	libc-alpha@sourceware.org, gcc-patches@gcc.gnu.org
Subject: Re: [RFC] bpf.2: Use standard types and attributes
Date: Sun, 25 Apr 2021 09:52:11 -0700	[thread overview]
Message-ID: <CAADnVQJU=r0qE-4ZHsvX4YndbFgDGvzAgNgVo7kPMGF4jCrVeg@mail.gmail.com> (raw)
In-Reply-To: <56932c68-4992-c5e4-819f-a88f60b3f63a@gmail.com>

On Sat, Apr 24, 2021 at 10:56 AM Alejandro Colomar (man-pages)
<alx.manpages@gmail.com> wrote:
>
> Hello Alexei,
>
> On 4/24/21 1:20 AM, Alexei Starovoitov wrote:
> > Nack.
> > The man page should describe the kernel api the way it is in .h file.
>
> Why?

Because man page must describe the linux uapi headers the way they
are installed in the system and not invent alternative implementations.
The users will include those .h with __u32 and will see them in their code.
Man page saying something else is a dangerous lie.

> using uint32_t in every situation where __u32 is expected.  They're both
> typedefs for the same basic type.

That's irrelevant. Languages like golang have their own bpf.h equivalent
that matches /usr/include/linux/bpf.h.

> I can understand why Linux will keep using u32 types (and their __ user
> space variants), but that doesn't mean user space programs need to use
> the same type.

No one says that the users must use __u32. See golang example.
But if the users do #include <linux/bpf.h> they will get them and man page
must describe that.

> If we have a standard syntax for fixed-width integral types (and for
> anything, actually), the manual pages should probably follow it,
> whenever possible.

Absolutely not. linux man page must describe linux.

  reply	other threads:[~2021-04-25 16:52 UTC|newest]

Thread overview: 68+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-23 23:06 [RFC] bpf.2: Use standard types and attributes Alejandro Colomar
2021-04-23 23:20 ` Alexei Starovoitov
2021-04-24 17:56   ` Alejandro Colomar (man-pages)
2021-04-25 16:52     ` Alexei Starovoitov [this message]
2021-04-25 19:12       ` Zack Weinberg
2021-04-24 20:43   ` David Laight
2021-04-25 19:16     ` Zack Weinberg
2021-04-25 21:09       ` David Laight
2021-04-26 17:19 ` Joseph Myers
2021-04-26 17:46   ` Alejandro Colomar (man-pages)
2021-05-04 11:05 ` [RFC v2] " Alejandro Colomar
2021-05-04 14:12   ` Alexei Starovoitov
2021-05-04 14:24     ` Greg KH
2021-05-04 15:53       ` Alejandro Colomar (man-pages)
2021-05-04 16:06         ` Greg KH
2021-05-04 18:37           ` Zack Weinberg
2021-05-04 18:54             ` Alejandro Colomar (man-pages)
2021-05-04 19:45               ` Florian Weimer
2021-05-04 19:59                 ` Alejandro Colomar (man-pages)
2021-05-05  8:23                 ` David Laight
2021-05-05 22:22                   ` Joseph Myers
2021-05-04 20:06               ` Daniel Borkmann
2021-05-04 20:16                 ` Alejandro Colomar (man-pages)
2021-05-04 20:33                 ` Zack Weinberg
2021-05-04 21:23                   ` Alexei Starovoitov
2021-05-15 19:01               ` [PATCH v3] " Alejandro Colomar
2021-05-16  9:16                 ` Alejandro Colomar (man-pages)
2021-05-17 18:56                   ` Daniel Borkmann
2021-05-21 11:12                     ` Alejandro Colomar
2021-05-04 16:08         ` [RFC v2] " Daniel Borkmann
2022-08-24 18:55 ` [PATCH v3] Many pages: Document fixed-width types with ISO C naming Alejandro Colomar
2022-08-24 18:55   ` [LTP] " Alejandro Colomar
2022-08-24 22:40   ` Alexei Starovoitov
2022-08-24 22:40     ` [LTP] " Alexei Starovoitov
2022-08-24 23:36     ` Alejandro Colomar
2022-08-24 23:36       ` [LTP] " Alejandro Colomar
2022-08-25  0:52       ` Linus Torvalds
2022-08-25  0:52         ` [LTP] " Linus Torvalds
2022-08-25  7:20         ` Alejandro Colomar
2022-08-25  7:20           ` [LTP] " Alejandro Colomar
2022-08-25  7:28           ` Xi Ruoyao
2022-08-25  7:28             ` [LTP] " Xi Ruoyao via ltp
2022-08-25  7:48             ` Alejandro Colomar
2022-08-25  7:48               ` [LTP] " Alejandro Colomar
2022-08-25  8:09               ` Xi Ruoyao
2022-08-25  8:09                 ` [LTP] " Xi Ruoyao via ltp
2022-08-25  7:42           ` Linus Torvalds
2022-08-25  7:42             ` [LTP] " Linus Torvalds
2022-08-25  7:59             ` Alejandro Colomar
2022-08-25  7:59               ` [LTP] " Alejandro Colomar
2022-08-25  5:57       ` Greg Kroah-Hartman
2022-08-25  5:57         ` [LTP] " Greg Kroah-Hartman
2022-08-25  6:41         ` Florian Weimer
2022-08-25  6:41           ` [LTP] " Florian Weimer
2022-08-25  7:27           ` Linus Torvalds
2022-08-25  7:27             ` [LTP] " Linus Torvalds
2022-08-25 14:38             ` Joseph Myers
2022-08-25 14:38               ` [LTP] " Joseph Myers
2022-08-25 15:01               ` David Laight
2022-08-25 15:01                 ` David Laight
2022-08-25 15:37                 ` Joseph Myers
2022-08-25 15:37                   ` [LTP] " Joseph Myers
2022-08-25 16:43               ` Linus Torvalds
2022-08-25 16:43                 ` Linus Torvalds
2022-08-25  7:44         ` Alejandro Colomar
2022-08-25  7:44           ` [LTP] " Alejandro Colomar
2022-08-25  8:04           ` Alejandro Colomar
2022-08-25  8:04             ` [LTP] " 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='CAADnVQJU=r0qE-4ZHsvX4YndbFgDGvzAgNgVo7kPMGF4jCrVeg@mail.gmail.com' \
    --to=alexei.starovoitov@gmail.com \
    --cc=alx.manpages@gmail.com \
    --cc=bpf@vger.kernel.org \
    --cc=gcc-patches@gcc.gnu.org \
    --cc=libc-alpha@sourceware.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-man@vger.kernel.org \
    --cc=mtk.manpages@gmail.com \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.