e5ee4be8b3
This patchset brings the README.rst and the overview.rst documentation together. Previously they were maintained separately which causes maintenance issues. This adds a symlink from the overview.rst to the README.rst so that the overview documentation only needs to be maintained for the README. This also adds a Terminology subsection underneath the "How it works" section which expands on essential terminology needed to understand Patrole testing architecture: * Expected Result - The expected result of a given test. * Actual Result - The actual result of a given test. * Final Result - A match between both expected and actual results. A mismatch in the expected result and the actual result will result in a test failure. * Expected: Pass | Actual: Pass - Test Case Success * Expected: Pass | Actual: Fail - Test Case Failure * Expected: Fail | Actual: Pass - Test Case Failure * Expected: Fail | Actual: Fail (Expected exception) - Test Case Success * Expected: Fail | Actual: Fail (Unexpected exception) - Test Case Failure Change-Id: I1d640200c55ce26cfd38197ec6face1161217b17
Symbolic link
16 B
Symbolic link
16 B
../../README.rst