]> git.puffer.fish Git - matthieu/frr.git/commitdiff
lib: explain semantics of northbound operations
authorIgor Ryzhov <iryzhov@nfware.com>
Mon, 13 Nov 2023 22:39:59 +0000 (23:39 +0100)
committerIgor Ryzhov <iryzhov@nfware.com>
Thu, 11 Jan 2024 13:06:53 +0000 (15:06 +0200)
Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>
lib/northbound.h

index 3dd9d09d4a63f850d8e6dc3aa0f246eebb81c777..f4ff8d2308aa0d72f8af5090689b56ae9d210dbd 100644 (file)
@@ -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 {