netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Guillaume Nault <gnault@redhat.com>
To: Jakub Kicinski <kuba@kernel.org>
Cc: davem@davemloft.net, netdev@vger.kernel.org, edumazet@google.com,
	pabeni@redhat.com, robh@kernel.org, johannes@sipsolutions.net,
	ecree.xilinx@gmail.com, stephen@networkplumber.org,
	sdf@google.com, f.fainelli@gmail.com, fw@strlen.de,
	linux-doc@vger.kernel.org, razor@blackwall.org,
	nicolas.dichtel@6wind.com, Bagas Sanjaya <bagasdotme@gmail.com>
Subject: Re: [PATCH net-next v2 1/7] docs: add more netlink docs (incl. spec docs)
Date: Mon, 10 Oct 2022 11:56:45 +0200	[thread overview]
Message-ID: <20221010095645.GA3551@localhost.localdomain> (raw)
In-Reply-To: <20220930023418.1346263-2-kuba@kernel.org>

On Thu, Sep 29, 2022 at 07:34:12PM -0700, Jakub Kicinski wrote:
> +==============================
> +Netlink spec C code generation
> +==============================
> +
> +This document describes how Netlink specifications are used to render
> +C code (uAPI, policies etc.). It also defines the additional properties
> +allowed in older families by the ``genetlink-c`` protocol level,
> +to control the naming.
> +
> +For brevity this document refers to ``name`` properties of various
> +objects by the object type. For example ``$attr`` is the value
> +of ``name`` in an attribute, and ``$family`` is the name of the
> +family (the global ``name`` property).
> +
> +The upper case is used to denote literal values, e.g. ``$family-CMD``
> +means the concatenation of ``$family``, a dash character, and the literal
> +``CMD``.
> +
> +The names of ``#defines`` and enum values are always converted to upper case,
> +and with dashes (``-``) replaced by underscores (``_``).
> +
> +If the constructured name is a C keyword, an extra underscore is

s/constructured/constructed/

[...]

> +header
> +~~~~~~
> +
> +For C-compatible languages, header which already defines this value.
> +In case the definition is shared by multiple families (e.g. ``IFNAMSIZ``)
> +code generators for C-compabile languages may prefer to add an appropriate

s/C-compabile/C-compatible/


  reply	other threads:[~2022-10-10  9:57 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-09-30  2:34 [PATCH net-next v2 0/7] Netlink protocol specs Jakub Kicinski
2022-09-30  2:34 ` [PATCH net-next v2 1/7] docs: add more netlink docs (incl. spec docs) Jakub Kicinski
2022-10-10  9:56   ` Guillaume Nault [this message]
2022-09-30  2:34 ` [PATCH net-next v2 2/7] netlink: add schemas for YAML specs Jakub Kicinski
2022-09-30  2:34 ` [PATCH net-next v2 3/7] net: add basic C code generators for Netlink Jakub Kicinski
2022-10-06 12:51   ` Guillaume Nault
2022-10-06 14:55     ` Jakub Kicinski
2022-10-07  8:54       ` Guillaume Nault
2022-09-30  2:34 ` [PATCH net-next v2 4/7] netlink: add a proto specification for FOU Jakub Kicinski
2022-09-30  2:34 ` [PATCH net-next v2 5/7] net: fou: regenerate the uAPI from the spec Jakub Kicinski
2022-09-30  2:34 ` [PATCH net-next v2 6/7] net: fou: rename the source for linking Jakub Kicinski
2022-09-30  2:34 ` [PATCH net-next v2 7/7] net: fou: use policy and operation tables generated from the spec Jakub Kicinski

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=20221010095645.GA3551@localhost.localdomain \
    --to=gnault@redhat.com \
    --cc=bagasdotme@gmail.com \
    --cc=davem@davemloft.net \
    --cc=ecree.xilinx@gmail.com \
    --cc=edumazet@google.com \
    --cc=f.fainelli@gmail.com \
    --cc=fw@strlen.de \
    --cc=johannes@sipsolutions.net \
    --cc=kuba@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=netdev@vger.kernel.org \
    --cc=nicolas.dichtel@6wind.com \
    --cc=pabeni@redhat.com \
    --cc=razor@blackwall.org \
    --cc=robh@kernel.org \
    --cc=sdf@google.com \
    --cc=stephen@networkplumber.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).