From: Igor Ryzhov <iryzhov@nfware.com>
Date: Mon, 13 Nov 2023 22:39:59 +0000 (+0100)
Subject: lib: explain semantics of northbound operations
X-Git-Tag: base_10.0~127^2
X-Git-Url: https://git.puffer.fish/?a=commitdiff_plain;h=7e48299c58bd36606895a3db119716f8a7e6a1b1;p=matthieu%2Ffrr.git

lib: explain semantics of northbound operations

Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>
---

diff --git a/lib/northbound.h b/lib/northbound.h
index 3dd9d09d4a..f4ff8d2308 100644
--- a/lib/northbound.h
+++ b/lib/northbound.h
@@ -716,15 +716,18 @@ struct nb_config {
 	uint32_t version;
 };
 
-/* Northbound operations */
+/*
+ * Northbound operations. The semantics of operations is explained in RFC 8072,
+ * section 2.5: https://datatracker.ietf.org/doc/html/rfc8072#section-2.5.
+ */
 enum nb_operation {
-	NB_OP_CREATE_EXCL,
-	NB_OP_CREATE,
-	NB_OP_MODIFY,
-	NB_OP_DESTROY,
-	NB_OP_DELETE,
-	NB_OP_REPLACE,
-	NB_OP_MOVE,
+	NB_OP_CREATE_EXCL,	/* "create" */
+	NB_OP_CREATE,		/* "merge" - kept for backward compatibility */
+	NB_OP_MODIFY,		/* "merge" */
+	NB_OP_DESTROY,		/* "remove" */
+	NB_OP_DELETE,		/* "delete" */
+	NB_OP_REPLACE,		/* "replace" */
+	NB_OP_MOVE,		/* "move" */
 };
 
 struct nb_cfg_change {