From: Elise Lennion <elise.lennion@gmail.com>
To: pablo@netfilter.org
Cc: netfilter-devel@vger.kernel.org
Subject: [PATCH nft 3/3] doc: Document add / delete element operations of sets and maps
Date: Fri, 17 Mar 2017 12:04:48 -0300 [thread overview]
Message-ID: <20170317150448.GA1318@lennorien.com> (raw)
The add / delete operations weren't documented yet. They fit better
in the sets and maps blocks since these operations are used to directly
modify their content.
Signed-off-by: Elise Lennion <elise.lennion@gmail.com>
---
doc/nft.xml | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 58 insertions(+)
diff --git a/doc/nft.xml b/doc/nft.xml
index a63b4c2..9624703 100644
--- a/doc/nft.xml
+++ b/doc/nft.xml
@@ -697,6 +697,19 @@ filter input iif $int_ifs accept
<arg choice="req"><replaceable>table</replaceable></arg>
<arg choice="req"><replaceable>set</replaceable></arg>
</cmdsynopsis>
+ <cmdsynopsis>
+ <group choice="req">
+ <arg>add</arg>
+ <arg>delete</arg>
+ </group>
+ <command> element</command>
+ <arg choice="opt"><replaceable>family</replaceable></arg>
+ <arg choice="req"><replaceable>table</replaceable></arg>
+ <arg choice="req"><replaceable>set</replaceable></arg>
+ {
+ <arg choice="req"><replaceable>elements</replaceable></arg>
+ }
+ </cmdsynopsis>
</para>
<para>
Sets are elements containers of an user-defined data type, they are uniquely identified by an user-defined name and attached to tables.
@@ -735,6 +748,22 @@ filter input iif $int_ifs accept
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><option>add element</option></term>
+ <listitem>
+ <para>
+ Comma-separated list of elements to add into the specified set.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>delete element</option></term>
+ <listitem>
+ <para>
+ Comma-separated list of elements to delete from the specified set.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
<table frame="all">
@@ -819,6 +848,19 @@ filter input iif $int_ifs accept
<arg choice="req"><replaceable>table</replaceable></arg>
<arg choice="req"><replaceable>map</replaceable></arg>
</cmdsynopsis>
+ <cmdsynopsis>
+ <group choice="req">
+ <arg>add</arg>
+ <arg>delete</arg>
+ </group>
+ <command> element</command>
+ <arg choice="opt"><replaceable>family</replaceable></arg>
+ <arg choice="req"><replaceable>table</replaceable></arg>
+ <arg choice="req"><replaceable>map</replaceable></arg>
+ {
+ <arg choice="req"><replaceable>elements</replaceable></arg>
+ }
+ </cmdsynopsis>
</para>
<para>
Maps store data based on some specific key used as input, they are uniquely identified by an user-defined name and attached to tables.
@@ -857,6 +899,22 @@ filter input iif $int_ifs accept
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><option>add element</option></term>
+ <listitem>
+ <para>
+ Comma-separated list of elements to add into the specified map.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>delete element</option></term>
+ <listitem>
+ <para>
+ Comma-separated list of element keys to delete from the specified map.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
<table frame="all">
--
2.7.4
next reply other threads:[~2017-03-17 15:06 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-03-17 15:04 Elise Lennion [this message]
2017-03-20 10:16 ` [PATCH nft 3/3] doc: Document add / delete element operations of sets and maps Pablo Neira Ayuso
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=20170317150448.GA1318@lennorien.com \
--to=elise.lennion@gmail.com \
--cc=netfilter-devel@vger.kernel.org \
--cc=pablo@netfilter.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 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.