summaryrefslogtreecommitdiff
path: root/doc/developer
diff options
context:
space:
mode:
Diffstat (limited to 'doc/developer')
-rw-r--r--doc/developer/topotests-jsontopo.rst6
-rw-r--r--doc/developer/topotests.rst6
2 files changed, 12 insertions, 0 deletions
diff --git a/doc/developer/topotests-jsontopo.rst b/doc/developer/topotests-jsontopo.rst
index bbae80f11d..1c77cd7be1 100644
--- 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 7e627781e0..b32f2bbf49 100644
--- 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
"""""""""""""""""""""""