doc: add note about generous BGP topotest timeouts

Add note blocks to the topotest and topotest-json dev docs to
emphasize the need for generous BGP retry/convergence timers.

Signed-off-by: Mark Stapp <mjs@voltanet.io>

diff --git a/doc/developer/topotests-jsontopo.rst b/doc/developer/topotests-jsontopo.rst
index bbae80f11ded57af76f8d940b9e661f17370255b..1c77cd7be1282b1a56b93c64f595f7e1d3fbde65 100644 (file)
--- a/doc/developer/topotests-jsontopo.rst
+++ b/doc/developer/topotests-jsontopo.rst
@@ -55,8 +55,14 @@ This is the recommended test writing routine:
 * Create topology from json
 * Create configuration from json
 * Write the tests
+* Format the new code using `black <https://github.com/psf/black>`_
 * Create a Pull Request
 
+.. Note::
+
+   BGP tests MUST use generous convergence timeouts - you must ensure
+   that any test involving BGP uses a convergence timeout of at least
+   130 seconds.
 
 File Hierarchy
 ^^^^^^^^^^^^^^

diff --git a/doc/developer/topotests.rst b/doc/developer/topotests.rst
index 7e627781e009b8a8045acfe742dedc9f2bff6395..b32f2bbf49b111b7e99467d00e5cafd96673527b 100644 (file)
--- a/doc/developer/topotests.rst
+++ b/doc/developer/topotests.rst
@@ -363,6 +363,12 @@ This is the recommended test writing routine:
 - Format the new code using `black <https://github.com/psf/black>`_
 - Create a Pull Request
 
+.. Note::
+
+   BGP tests MUST use generous convergence timeouts - you must ensure
+   that any test involving BGP uses a convergence timeout of at least
+   130 seconds.
+
 Topotest File Hierarchy
 """""""""""""""""""""""