Skip to content

Commit

Permalink
Updated documentation for Behaviour of Xfail tests
Browse files Browse the repository at this point in the history
  • Loading branch information
Vineet1101 committed Jan 31, 2025
1 parent 029f830 commit b6a5eba
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions docs/P4c-test-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,9 @@ Refer to the repository documentation and existing test examples to understand t

An Xfail test is one that is expected to fail due to a known issue or limitation in the P4 compiler. The CI system handles these tests differently based on their type (positive or negative).




### Marking a Test as Xfail

1. **Adding the Xfail Mark**:
Expand All @@ -134,11 +137,17 @@ An Xfail test is one that is expected to fail due to a known issue or limitation

3. **Maintaining Consistency**:

- Note that not all CI systems may treat Xfail tests the same way. For now, document the current behavior in the repository's CI documentation.
- Add a TODO comment or issue to make the handling of Xfail tests consistent across all CI workflows in the future.
- Note that different p4c backends may treat Xfail tests differently. **TODO**: Investigate and document how each p4c backend handles Xfail tests to ensure consistency across the project.

- **TODO**: Document which p4c backend tests treat Xfail as described above versus those that treat Xfail differently.





---


## **5. Running Tests**

Tests in the P4C repository can be executed in two main ways:
Expand Down

0 comments on commit b6a5eba

Please sign in to comment.