Minor update of documentation for RDE implementation

lucacorti · May 20, 2023 · 4cd1c44 · 4cd1c44
1 parent 67e4723
commit 4cd1c44
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/lib/bgp/server/rde.ex b/lib/bgp/server/rde.ex
@@ -1,5 +1,12 @@
 defmodule BGP.Server.RDE do
-  @moduledoc false
+  @moduledoc """
+  RDE implementation based on RFC4271 section 9 (https://www.rfc-editor.org/rfc/rfc4271#section-9):
+
+    * performs preference calculation for received routes.
+    * performs route selection and maintains Adj-RIB-In, Loc-Rib, Adjs-RIB-Out in ETS.
+    * performs route dissemination to peers after processing updates.
+
+  """
 
   alias BGP.{Message.UPDATE, Server}