summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorQuentin Young <qlyoung@users.noreply.github.com>2020-07-07 17:27:53 +0200
committerGitHub <noreply@github.com>2020-07-07 17:27:53 +0200
commit5b76e76515f5b0bab1748fd90b7eaf1642a061df (patch)
tree7efe9348ece364ce058a1fd295e262c9c5cb0035
parentMerge pull request #6685 from donaldsharp/fix_rare_ospf_test_failure (diff)
parentdoc: add note about generous BGP topotest timeouts (diff)
downloadfrr-5b76e76515f5b0bab1748fd90b7eaf1642a061df.tar.xz
frr-5b76e76515f5b0bab1748fd90b7eaf1642a061df.zip
Merge pull request #6689 from mjstapp/doc_topotest_timeouts
doc: add note about generous BGP topotest timeouts
-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 bbae80f11..1c77cd7be 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 7e627781e..b32f2bbf4 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
"""""""""""""""""""""""