diff options
| author | Quentin Young <qlyoung@users.noreply.github.com> | 2020-07-07 11:27:53 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-07-07 11:27:53 -0400 |
| commit | 5b76e76515f5b0bab1748fd90b7eaf1642a061df (patch) | |
| tree | 7efe9348ece364ce058a1fd295e262c9c5cb0035 /doc/developer | |
| parent | 3a298c75fd353ed00e49caff7718e7c3077fe8d3 (diff) | |
| parent | d9c43f8f19cfa7ec389824630947379307b7d515 (diff) | |
Merge pull request #6689 from mjstapp/doc_topotest_timeouts
doc: add note about generous BGP topotest timeouts
Diffstat (limited to 'doc/developer')
| -rw-r--r-- | doc/developer/topotests-jsontopo.rst | 6 | ||||
| -rw-r--r-- | doc/developer/topotests.rst | 6 |
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 """"""""""""""""""""""" |