zebra: Note about functionality in rt.h

When we are modifying the kernel there could
be multiple modules/hooks involved in this
process.  As such let the caller set
the appropriate flags for success/failure.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>

diff --git a/zebra/rt.h b/zebra/rt.h
index f5f0fa195b380d83f7990f605923fe191000bf46..3ce15e964022377ebe00f4d4e0ab6bd50a047387 100644 (file)
--- a/zebra/rt.h
+++ b/zebra/rt.h
@@ -30,6 +30,17 @@
 #include "zebra/zebra_ns.h"
 #include "zebra/zebra_mpls.h"
 
+/*
+ * Philosophy Note:
+ *
+ * Flags being SET/UNSET do not belong in the South Bound
+ * Interface.  This Setting belongs at the calling level
+ * because we can and will have multiple different interfaces
+ * and we will have potentially multiple different
+ * modules/filters to call.  As such Setting/Unsetting
+ * success failure should be handled by the caller.
+ */
+
 extern int kernel_route_rib(struct prefix *, struct prefix *,
                            struct route_entry *, struct route_entry *);