X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper%2Ftests%2Foverview.rst;fp=test%2Fdoc%2Foverview.rst;h=cc9836e39927b18904c329572a4c5ad01b3efb12;hb=9ad39c026c8a3c945a7003c4aa4f5cb1d4c80160;hp=0c07cb6111fce6e60471fc1c83e4d4701c70f8d4;hpb=f47122e07e1ecd0151902a3cabe46c60a99bee8e;p=vpp.git diff --git a/test/doc/overview.rst b/docs/developer/tests/overview.rst similarity index 98% rename from test/doc/overview.rst rename to docs/developer/tests/overview.rst index 0c07cb6111f..cc9836e3992 100644 --- a/test/doc/overview.rst +++ b/docs/developer/tests/overview.rst @@ -118,7 +118,7 @@ The test temporary directory holds the following interesting files: named after the interface, so for e.g. pg1, the file will be named pg1_out.pcap * history files - whenever the capture is restarted or a new stream is added, - the existing files are rotated and renamed, soo all the pcap files + the existing files are rotated and renamed, so all the pcap files are always saved for later debugging if needed * core - if vpp dumps a core, it'll be stored in the temporary directory * vpp_stdout.txt - file containing output which vpp printed to stdout @@ -216,7 +216,7 @@ The following APIs are available to the test case for reading pcap files. written by the VPP. If using packet infos for verifying packets, then the counts of the packet infos can be automatically used by `VppPGInterface.get_capture` to get the proper count (in this case - the default value None can be supplied as expected_count or ommitted + the default value None can be supplied as expected_count or omitted altogether). * `VppPGInterface.wait_for_packet`: this API is suitable for interactive style of test, e.g. when doing session management, @@ -239,8 +239,8 @@ Automatic filtering of packets: Both APIs (`VppPGInterface.get_capture` and `VppPGInterface.wait_for_packet`) by default filter the packet capture, removing known uninteresting packets from it - these are IPv6 -Router Advertisments and IPv6 Router Alerts. These packets are -unsolicitated and from the point of |vtf| are random. If a test wants +Router Advertisements and IPv6 Router Alerts. These packets are +unsolicited and from the point of |vtf| are random. If a test wants to receive these packets, it should specify either None or a custom filtering function as the value to the 'filter_out_fn' argument.