From: Donald Sharp <sharpd@cumulusnetworks.com>
Date: Mon, 15 May 2017 23:37:16 +0000 (-0400)
Subject: lib: Add some more documentation to vrf.h
X-Git-Tag: reindent-master-before~149^2~4
X-Git-Url: https://git.puffer.fish/?a=commitdiff_plain;h=97b1a80cbb7ca5582972d700dbed6e011cbd9f83;p=matthieu%2Ffrr.git

lib: Add some more documentation to vrf.h

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

diff --git a/lib/vrf.h b/lib/vrf.h
index a08258a929..14917eec02 100644
--- a/lib/vrf.h
+++ b/lib/vrf.h
@@ -143,12 +143,31 @@ extern int vrf_bitmap_check (vrf_bitmap_t, vrf_id_t);
 
 /*
  * VRF initializer/destructor
+ *
+ * create -> Called back when a new VRF is created.  This
+ *           can be either through these 3 options:
+ *           1) CLI mentions a vrf before OS knows about it
+ *           2) OS calls zebra and we create the vrf from OS
+ *              callback
+ *           3) zebra calls individual protocols to notify
+ *              about the new vrf
+ *
+ * enable -> Called back when a VRF is actually usable from
+ *           an OS perspective ( 2 and 3 above )
+ *
+ * disable -> Called back when a VRF is being deleted from
+ *            the system ( 2 and 3 ) above
+ *
+ * delete -> Called back when a vrf is being deleted from
+ *           the system ( 2 and 3 ) above.
  */
-/* Please add hooks before calling vrf_init(). */
 extern void vrf_init (int (*create)(struct vrf *),
 		      int (*enable)(struct vrf *),
 		      int (*disable)(struct vrf *),
 		      int (*delete)(struct vrf *));
+/*
+ * Call vrf_terminate when the protocol is being shutdown
+ */
 extern void vrf_terminate (void);
 
 extern void vrf_cmd_init (int (*writefunc)(struct vty *vty));