Adds some documentation to the description option.

diff --git a/doc/bird.conf.example b/doc/bird.conf.example
index 0a2aac7eaf7cde9aa830b2be8dbfe08a3e00573c..6ab03a23f7ef27480c2e4213652e242df69ae4b7 100644 (file)
--- a/doc/bird.conf.example
+++ b/doc/bird.conf.example
@@ -162,6 +162,7 @@ protocol static {
 
 #protocol bgp {
 #      disabled;
+#      description "My BGP uplink"
 #      local as 65000;
 #      neighbor 62.168.0.130 as 5588;
 #      multihop 20 via 62.168.0.13;

diff --git a/doc/bird.sgml b/doc/bird.sgml
index 40793ed37fbda7731235d325d83e8813818e3e45..b475830eeb278479f22fe6f7d2509c71fa67aa32 100644 (file)
--- a/doc/bird.sgml
+++ b/doc/bird.sgml
@@ -307,6 +307,10 @@ to zero to disable it. An empty <cf><m/switch/</cf> is equivalent to <cf/on/
        <tag>export <m/filter/</tag> This is similar to the <cf>import</cf> keyword, except that it
        works in the direction from the routing table to the protocol. Default: <cf/none/.
 
+       <tag>description "<m/text/"</tag> This is an optional
+       description of the protocol. It is displayed as a part of the
+       output of 'show route all' command.
+
        <tag>table <m/name/</tag> Connect this protocol to a non-default routing table.
 </descrip>