Linux Netfilter development
 help / color / mirror / Atom feed
From: Harald Welte <laforge@gnumonks.org>
To: netfilter-devel@vger.kernel.org
Subject: nftables documentation improvement?
Date: Sat, 23 Mar 2024 09:54:50 +0100	[thread overview]
Message-ID: <Zf6Y2s6eyrhlWLZz@nataraja> (raw)

Dear netfilter project,

In my recent interaction explaining nftables to some other users I am
under the impression that there is likely some improvement possible to
the nftables wiki.

The wiki is full of details about the individual expressions, actions,
etc. - but I think what's lacking (or I couldn't find it) is some kind
of conscise overall description of the terminology + the general
high-level architecture of the ruleset.

You can find some description in the first two paragraphs of 
https://wiki.nftables.org/wiki-nftables/index.php/Simple_rule_management
but that doesn't define the terms used (action, expression, statement,
...)

You can find an overview of the terms used in
https://wiki.nftables.org/wiki-nftables/index.php/Quick_reference-nftables_in_10_minutes
[but then actually with imprecise language like "rule refers to an
action to be configured within a chain." while a rule actually consists
of matching expressions and an action"]

I'd be willing to try to write a proposed improvded text expressing what
I have in mind.  I'd prefer to do that as some separate wiki page as a
draft for you guys to review before deciding whether to use it in the
main wiki pages.  I just didn't want to write it as unformatted
plain-text here in e-mail and then later have to re-format in wiki
syntax.

So in short: If anybody would be willing to add an account for me, I'd
give it a shot and you can decide if you think what I'd consider an
improvement is also one in your point of view.

Thanks,
	Harald

p.s.: I'm not subscribed to the list since becoming emeritus status a long
time ago, so please Cc me in any responses.

-- 
- Harald Welte <laforge@gnumonks.org>          https://laforge.gnumonks.org/
============================================================================
"Privacy in residential applications is a desirable marketing option."
                                                  (ETSI EN 300 175-7 Ch. A6)

             reply	other threads:[~2024-03-23  9:17 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-23  8:54 Harald Welte [this message]
2024-03-23 21:03 ` nftables documentation improvement? Pablo Neira Ayuso
2024-03-26 13:59   ` Harald Welte

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=Zf6Y2s6eyrhlWLZz@nataraja \
    --to=laforge@gnumonks.org \
    --cc=netfilter-devel@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