From 4b02d4a43c37e120394fff2cd3e73519025f3fe1 Mon Sep 17 00:00:00 2001 From: Andy Fingerhut Date: Sun, 23 Jun 2024 23:42:18 -0400 Subject: [PATCH] Make different Markdown files have different titles in Doxygen output (#4745) * Make different Markdown files have different titles in Doxygen output Signed-off-by: Andy Fingerhut * Correct name to use proper capitalization Signed-off-by: Andy Fingerhut --------- Signed-off-by: Andy Fingerhut --- backends/p4tools/CONTRIBUTORS.md | 2 +- backends/p4tools/cmake/README.md | 2 ++ backends/p4tools/common/README.md | 2 ++ backends/p4tools/common/lib/README.md | 2 ++ backends/p4tools/modules/smith/README.md | 2 ++ backends/p4tools/modules/testgen/README.md | 2 ++ .../p4tools/modules/testgen/lib/README.md | 2 ++ .../testgen/targets/bmv2/test/README.md | 27 +++++++++++-------- backends/ubpf/docs/EXAMPLES.md | 4 +-- backends/ubpf/tests/README.md | 4 ++- ir/README.md | 2 +- lib/README.md | 2 +- 12 files changed, 36 insertions(+), 17 deletions(-) diff --git a/backends/p4tools/CONTRIBUTORS.md b/backends/p4tools/CONTRIBUTORS.md index 38e5ae22472..a58f5218e8f 100644 --- a/backends/p4tools/CONTRIBUTORS.md +++ b/backends/p4tools/CONTRIBUTORS.md @@ -1,4 +1,4 @@ -# Overview +# P4Tools Contributors P4Testgen is a test oracle for the P4 language. Given a P4_16 program and a specification of the underlying architecture, it automatically generates a comprehensive set of input/output tests that can be executed to validate a target device. diff --git a/backends/p4tools/cmake/README.md b/backends/p4tools/cmake/README.md index ba4670d9e4b..9d3dee6c3de 100644 --- a/backends/p4tools/cmake/README.md +++ b/backends/p4tools/cmake/README.md @@ -1 +1,3 @@ +# P4Tools CMake + This directory provides CMake modules and helper functions for building the various components of P4Tools and running tests. diff --git a/backends/p4tools/common/README.md b/backends/p4tools/common/README.md index a3a4d2b2765..fa22162cf35 100644 --- a/backends/p4tools/common/README.md +++ b/backends/p4tools/common/README.md @@ -1 +1,3 @@ +# P4Tools Common C++ code + This directory provides shared C++ components for the various P4Tools modules. diff --git a/backends/p4tools/common/lib/README.md b/backends/p4tools/common/lib/README.md index 42f96ca46a8..6f1bd954e93 100644 --- a/backends/p4tools/common/lib/README.md +++ b/backends/p4tools/common/lib/README.md @@ -1 +1,3 @@ +# P4Tools Common Library Code + A library of data structures shared by the various P4Tools modules. diff --git a/backends/p4tools/modules/smith/README.md b/backends/p4tools/modules/smith/README.md index 8dfc4b047ae..2f7018244b6 100644 --- a/backends/p4tools/modules/smith/README.md +++ b/backends/p4tools/modules/smith/README.md @@ -1,3 +1,5 @@ +# P4Smith + [![Status](https://github.com/p4lang/p4c/actions/workflows/ci-p4tools.yml/badge.svg)](https://github.com/p4lang/p4c/actions/workflows/ci-p4tools.yml) # P4Smith diff --git a/backends/p4tools/modules/testgen/README.md b/backends/p4tools/modules/testgen/README.md index 6729e5fd456..53671e14ee5 100644 --- a/backends/p4tools/modules/testgen/README.md +++ b/backends/p4tools/modules/testgen/README.md @@ -1,3 +1,5 @@ +# P4Testgen + [![Status](https://github.com/p4lang/p4c/actions/workflows/ci-p4tools.yml/badge.svg)](https://github.com/p4lang/p4c/actions/workflows/ci-p4tools.yml) # Testgen diff --git a/backends/p4tools/modules/testgen/lib/README.md b/backends/p4tools/modules/testgen/lib/README.md index 814e825d216..2f01c6546a6 100644 --- a/backends/p4tools/modules/testgen/lib/README.md +++ b/backends/p4tools/modules/testgen/lib/README.md @@ -1 +1,3 @@ +# P4Testgen Library + A library of data structures to support p4testgen. diff --git a/backends/p4tools/modules/testgen/targets/bmv2/test/README.md b/backends/p4tools/modules/testgen/targets/bmv2/test/README.md index 1af60ccd565..2392c88dfc5 100644 --- a/backends/p4tools/modules/testgen/targets/bmv2/test/README.md +++ b/backends/p4tools/modules/testgen/targets/bmv2/test/README.md @@ -1,12 +1,17 @@ -CMake Files: -===================== -1) P4Tests.cmake - Common test suite to add P4 tests from P4C submodules. - - Run p4testgen on P4-16 V1Model p4s with the BMv2 target. -2) BMV2...Xfail.cmake - BMv2 xfails for the various BMv2 V1Model back ends. - -How to Run tests: -===================== -1) All P4C submodule tests are tagged with 'testgen-p4c-bmv2' label - - cd build/testgen - - ctest -R testgen-p4c-bmv2 +# P4Testgen BMv2 target tests + +## CMake Files + ++ P4Tests.cmake - Common test suite to add P4 tests from P4C submodules. + + Run p4testgen on P4-16 V1Model p4s with the BMv2 target. ++ BMV2...Xfail.cmake - BMv2 xfails for the various BMv2 V1Model back ends. + +## How to Run tests + ++ All P4C submodule tests are tagged with 'testgen-p4c-bmv2' label + +```bash +cd build/testgen +ctest -R testgen-p4c-bmv2 +``` diff --git a/backends/ubpf/docs/EXAMPLES.md b/backends/ubpf/docs/EXAMPLES.md index ca06633ecd1..a6e4e6907ad 100644 --- a/backends/ubpf/docs/EXAMPLES.md +++ b/backends/ubpf/docs/EXAMPLES.md @@ -1,4 +1,4 @@ -# Introduction +# uBPF Backend test programs This file contains description of the basic P4 programs, which were used to test the functionality of the P4-to-uBPF compiler. All tests have been run on the [P4rt-OVS](https://github.com/Orange-OpenSource/p4rt-ovs) switch. @@ -213,4 +213,4 @@ Scapy can be used to easily test GTP protocol: >>> load_contrib('gtp') >>> p = Ether(dst='08:00:27:7e:0b:95', src='08:00:27:15:b4:11')/IP(dst='172.16.0.14', src='172.16.0.12')/UDP(sport=2152,dport=2152)/GTPHeader(teid=3)/IP(dst='172.16.0.14', src='172.16.0.12')/ICMP() >>> sendp(p, iface='eth1') -``` \ No newline at end of file +``` diff --git a/backends/ubpf/tests/README.md b/backends/ubpf/tests/README.md index 6b5d4f450f4..43f1cfd84f5 100644 --- a/backends/ubpf/tests/README.md +++ b/backends/ubpf/tests/README.md @@ -1,3 +1,5 @@ +# uBPF Backend testing + # Steps to run tests Tests use two VMs: @@ -53,4 +55,4 @@ environment with two VMs (`generator` + `switch`). ``` In case of tests errors please check if the `p4rt-ovs` switch is up and running (ie. `ps aux`). - \ No newline at end of file + diff --git a/ir/README.md b/ir/README.md index 7dd97150bcc..2b88d3b099f 100644 --- a/ir/README.md +++ b/ir/README.md @@ -1,4 +1,4 @@ -# Intermediate Representation (IR) Classes {#irdefs} +# P4C Intermediate Representation (IR) Classes {#irdefs} The IR classes are automatically generated by tools/ir-generator from \*.def files. The .def files contain class definitions with diff --git a/lib/README.md b/lib/README.md index 97269ae5d2f..b1835a02f72 100644 --- a/lib/README.md +++ b/lib/README.md @@ -1,4 +1,4 @@ -# Common Utilities +# Common P4C utility functions This directory contains miscellaneous utilities that are generally useful and not specific to any part of the compiler. Most are not even compiler