From 3b31c538333156770ddb74a7a27f271784745144 Mon Sep 17 00:00:00 2001
From: Martin Mares <mj@ucw.cz>
Date: Sun, 4 Jun 2000 16:15:37 +0000
Subject: Documented all the trivial protocols.

---
 proto/pipe/pipe.c | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'proto/pipe/pipe.c')

diff --git a/proto/pipe/pipe.c b/proto/pipe/pipe.c
index 3f41faa..f7ba866 100644
--- a/proto/pipe/pipe.c
+++ b/proto/pipe/pipe.c
@@ -6,6 +6,18 @@
  *	Can be freely distributed and used under the terms of the GNU GPL.
  */
 
+/**
+ * DOC: Pipe
+ *
+ * The Pipe protocol is very simple. It just connects to two routing tables
+ * using proto_add_announce_hook() and whenever it receives a rt_notify()
+ * about a change in one of the tables, it converts it to a rte_update()
+ * in the other one.
+ *
+ * To avoid pipe loops, Pipe keeps a `being updated' flag in each routing
+ * table.
+ */
+
 #undef LOCAL_DEBUG
 
 #include "nest/bird.h"
-- 
cgit v1.2.3