bier: Document 'Protocol' argument to BierPurge ibus message

See #16 (comment) for details Signed-off-by: Nicolas Rybowski <[email protected]> Suggested-by: Renato Westphal <[email protected]>
holo-routing · Sep 9, 2024 · 81a0ab1 · 81a0ab1
1 parent 226f141
commit 81a0ab1
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/holo-utils/src/ibus.rs b/holo-utils/src/ibus.rs
@@ -117,6 +117,11 @@ pub enum IbusMsg {
     // Request to uninstall an entry in the BIRT.
     RouteBierDel(BierNbrUninstallMsg),
     // Purge the BIRT.
+    /* TODO: Add Protocol argument to BierPurge to specify which BIRT has to be purged.
+     *  E.g., One could ask to purge the BIRT populated by a specific instance
+     *  of OSPFv3 but not those populated by IS-IS.
+     *  See https://github.com/holo-routing/holo/pull/16#discussion_r1729456621.
+     */
     BierPurge,
 }