Make different Markdown files have different titles in Doxygen output (…

…p4lang#4745) * Make different Markdown files have different titles in Doxygen output Signed-off-by: Andy Fingerhut <andy_fingerhut@alum.wustl.edu> * Correct name to use proper capitalization Signed-off-by: Andy Fingerhut <andy_fingerhut@alum.wustl.edu> --------- Signed-off-by: Andy Fingerhut <andy_fingerhut@alum.wustl.edu>
thomascalvert-xlnx · Jun 24, 2024 · 4b02d4a · 4b02d4a
1 parent f781e0b
commit 4b02d4a
Show file tree

Hide file tree

Showing 12 changed files with 36 additions and 17 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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)
 
 # <img src="https://p4.org/wp-content/uploads/2021/05/Group-81.png" width="40">P4Smith

diff --git 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)
 
 # <img src="https://p4.org/wp-content/uploads/2021/05/Group-81.png" width="40">Testgen

diff --git 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
@@ -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
@@ -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')
-```
+```
diff --git 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`). 
-    
+    
diff --git 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
@@ -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
Original file line number	Diff line number	Diff line change
		@@ -1 +1,3 @@
		# P4Tools CMake

		This directory provides CMake modules and helper functions for building the various components of P4Tools and running tests.
Original file line number	Diff line number	Diff line change
		@@ -1 +1,3 @@
		# P4Tools Common C++ code

		This directory provides shared C++ components for the various P4Tools modules.
Original file line number	Diff line number	Diff line change
		@@ -1 +1,3 @@
		# P4Tools Common Library Code

		A library of data structures shared by the various P4Tools modules.
Original file line number	Diff line number	Diff line change
		@@ -1 +1,3 @@
		# P4Testgen Library

		A library of data structures to support p4testgen.