doc: Document add / delete element operations of sets and maps
PATCH 3/3 doc: Document add / delete element operations of sets and maps
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 <[email protected]>
--- doc/nft.xml | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+)
doc/nft.xml +58 -0
@@ -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">
Signature · 1 line
2.7.4
Quoted 3 lines · Elise Lennion
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.
Applied, thanks.
A couple requests:
1) Could you check that flow table flush command doesn't flush sets/maps too? This should be selective.
2) Could you add shell tests for this?
Thanks.