From 386e56ccef01f8e459479dafcf326e69ee34203f Mon Sep 17 00:00:00 2001 From: Adarsh Rawat Date: Sun, 17 Mar 2024 02:17:53 +0530 Subject: [PATCH] [documentation] Add hyperlinks to the actual directory in the README file (#4531) * Add directory link for examples in DPDK Added directory link for examples directory in DPDK backend's Guide * [Docs] Add Directory link for p4tc_samples [Docs] Added Directory link for "testdata/p4tc_samples" in Guide of "tc" Backend. * Add "examples" to link text Added "examples" term as link text along with "directory". * Add "testdata/p4tc_samples" to link text Added "testdata/p4tc_samples" term as link text along with "directory". * Add directory link for "examples" in "ubpf" Added directory link for examples directory in "ubpf" backend's Guide * [Fix] Formatting of directory name Co-authored-by: Fabian Ruffy <5960321+fruffy@users.noreply.github.com> * [Fix] Add 'the' before 'example' in documentation Co-authored-by: Fabian Ruffy <5960321+fruffy@users.noreply.github.com> --------- Co-authored-by: Fabian Ruffy <5960321+fruffy@users.noreply.github.com> --- backends/dpdk/README.md | 2 +- backends/tc/README.md | 2 +- backends/ubpf/README.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/backends/dpdk/README.md b/backends/dpdk/README.md index 8197e27eca..cc227b1b01 100644 --- a/backends/dpdk/README.md +++ b/backends/dpdk/README.md @@ -19,7 +19,7 @@ generates the 'spec' file to configure the DPDK pipeline. ## How to use it? -A sample P4 program can be found in the `examples` directory. To +A sample P4 program can be found in the [`examples` directory](./examples). To generate the 'spec' file: ```bash p4c-dpdk --arch psa vxlan.p4 -o vxlan.spec diff --git a/backends/tc/README.md b/backends/tc/README.md index 4de3067e72..43e29888e5 100644 --- a/backends/tc/README.md +++ b/backends/tc/README.md @@ -19,7 +19,7 @@ The backend for TC reuses code from the p4c-ebpf for generating c file. ## How to use it? -The sample p4 programs are located in the "testdata/p4tc_samples" directory. +The sample p4 programs are located in the [`testdata/p4tc_samples` directory](../../testdata/p4tc_samples). To generate the 'template' file, 'c' file and 'json' file: diff --git a/backends/ubpf/README.md b/backends/ubpf/README.md index 9296ef16cd..ef2a7fafd0 100644 --- a/backends/ubpf/README.md +++ b/backends/ubpf/README.md @@ -55,7 +55,7 @@ However, we introduced some modifications, which are listed below: ### How to use? -The sample P4 programs are located in `examples/` directory. We have tested them with the [P4rt-OVS](https://github.com/Orange-OpenSource/p4rt-ovs) switch - +The sample P4 programs are located in the [`examples/` directory](./examples). We have tested them with the [P4rt-OVS](https://github.com/Orange-OpenSource/p4rt-ovs) switch - the Open vSwitch that can be extended with BPF programs at runtime. See [the detailed tutorial](./docs/EXAMPLES.md) on how to run and test those examples. In order to generate the C code use the following command: