Merge pull request #2351 from donaldsharp/bgp_deprecation

[mirror_frr.git] / doc / user / bgp.rst

diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst
index c4427a33ceee96155cbbd71d44abdb744f179e70..ad6d366f9af334c3d2737fcd22c2085d4a032ed2 100644 (file)
--- a/doc/user/bgp.rst
+++ b/doc/user/bgp.rst
@@ -51,9 +51,7 @@ BGP connection is internal one or external one.
 .. clicmd:: router bgp ASN
 
    Enable a BGP protocol process with the specified ASN. After
-   this statement you can input any `BGP Commands`. You can not
-   create different BGP process under different ASN without
-   specifying `multiple-instance` (:ref:`multiple-instance`).
+   this statement you can input any `BGP Commands`.
 
 .. index:: no router bgp ASN
 .. clicmd:: no router bgp ASN
@@ -1934,31 +1932,38 @@ Server or both at the same time.
 Multiple instance
 -----------------
 
-To enable multiple view function of *bgpd*, you must turn on multiple instance
-feature beforehand.
+The multiple instances feature of *bgpd* is by default turned on.  This command
+is deprecated and will be removed in a future version of FRR.  If you do not
+want multiple instances, do not configure them from the cli.  Please note
+that some commands auto-generate a second instance.
 
 .. index:: bgp multiple-instance
 .. clicmd:: bgp multiple-instance
 
-   Enable BGP multiple instance feature. After this feature is enabled,
-   you can make multiple BGP instances or multiple BGP views.
+   Enable BGP multiple instance feature. This is the default
+   configuration and this cli will not be displayed.  This command
+   is deprecated and will be removed in the future.
 
 .. index:: no bgp multiple-instance
 .. clicmd:: no bgp multiple-instance
 
    Disable BGP multiple instance feature. You can not disable this feature
-   when BGP multiple instances or views exist.
+   when BGP multiple instances or views exist.  This command
+   is deprecated and will be removed in the future.
 
 When you want to make configuration more Cisco like one,
 
 .. index:: bgp config-type cisco
 .. clicmd:: bgp config-type cisco
 
-   Cisco compatible BGP configuration output.
+   Cisco compatible BGP configuration output.  This command is deprecated
+   and will be removed in a future version of FRR.  Please transition
+   to using the appropriate bgp commands to affect your behavior.
 
 When bgp config-type cisco is specified,
 
-``no synchronization`` is displayed.
+``no synchronization`` is displayed.  This command does nothing and
+is for display purposes only.
 ``no auto-summary`` is displayed.
 
 The ``network`` and ``aggregate-address`` arguments are displayed as::
@@ -1999,7 +2004,8 @@ command.
 .. index:: bgp config-type zebra
 .. clicmd:: bgp config-type zebra
 
-   FRR style BGP configuration. This is default.
+   FRR style BGP configuration. This is default.  This command is deprecated
+   and will be removed in the future.
 
 .. _bgp-instance-and-view: