From: Ondrej Zajicek (work) <santiago@crfreenet.org>
Date: Tue, 18 May 2021 18:41:01 +0000 (+0200)
Subject: Flowspec: Documentation update
X-Git-Tag: v2.0.9~69
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c3c691e95cd40d8654b720be8d9a8ae9fb050951;p=thirdparty%2Fbird.git

Flowspec: Documentation update
---

diff --git a/doc/bird.sgml b/doc/bird.sgml
index ff5992167..90ceb1841 100644
--- a/doc/bird.sgml
+++ b/doc/bird.sgml
@@ -5094,6 +5094,8 @@ Bitmask matching is written using <m/value/<cf>/</cf><m/mask/ or
 <cf/!/<m/value/<cf>/</cf><m/mask/ pairs. It means that <cf/(/<m/data/ <cf/&/
 <m/mask/<cf/)/ is or is not equal to <m/value/. It is also possible to use
 multiple value/mask pairs connected by logical operators <cf/&&/ or <cf/||/.
+Note that for negated matches, value must be either zero or equal to bitmask
+(e.g. !0x0/0xf or !0xf/0xf, but not !0x3/0xf).
 
 <sect2>IPv4 Flowspec
 
diff --git a/lib/flowspec.c b/lib/flowspec.c
index 14b42b528..df5c8da33 100644
--- a/lib/flowspec.c
+++ b/lib/flowspec.c
@@ -815,8 +815,8 @@ flow_builder_add_op_val(struct flow_builder *fb, byte op, u32 value)
  * @mask: bitmask
  *
  * It is required to set appropriate flowspec component type using function
- * flow_builder_set_type(). This function should return 1 for successful adding,
- * otherwise returns 0.
+ * flow_builder_set_type(). Note that for negation, value must be zero or equal
+ * to bitmask.
  */
 int
 flow_builder_add_val_mask(struct flow_builder *fb, byte op, u32 value, u32 mask)