From 7cb3ad444f7bff088676651436ee269edf75a242 Mon Sep 17 00:00:00 2001 From: Adarsh Date: Thu, 14 Mar 2024 09:09:03 +0530 Subject: [PATCH 1/7] Add directory link for examples in DPDK Added directory link for examples directory in DPDK backend's Guide --- backends/dpdk/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/backends/dpdk/README.md b/backends/dpdk/README.md index 8197e27eca..ce361fb6f7 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 From 9bf2397729084b7624026a326ead972ce128a677 Mon Sep 17 00:00:00 2001 From: Adarsh Date: Thu, 14 Mar 2024 10:17:00 +0530 Subject: [PATCH 2/7] [Docs] Add Directory link for p4tc_samples [Docs] Added Directory link for "testdata/p4tc_samples" in Guide of "tc" Backend. --- backends/tc/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/backends/tc/README.md b/backends/tc/README.md index 4de3067e72..1ec6591536 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: From f92ee8ab04ded495090e545f38286a0f964bbf6d Mon Sep 17 00:00:00 2001 From: Adarsh Rawat Date: Fri, 15 Mar 2024 20:46:12 +0530 Subject: [PATCH 3/7] Add "examples" to link text Added "examples" term as link text along with "directory". --- backends/dpdk/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/backends/dpdk/README.md b/backends/dpdk/README.md index ce361fb6f7..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](./examples). 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 From bd6a7f1b1de1f1726fb0a46bbfb6510280d47a7b Mon Sep 17 00:00:00 2001 From: Adarsh Rawat Date: Fri, 15 Mar 2024 20:49:01 +0530 Subject: [PATCH 4/7] Add "testdata/p4tc_samples" to link text Added "testdata/p4tc_samples" term as link text along with "directory". --- backends/tc/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/backends/tc/README.md b/backends/tc/README.md index 1ec6591536..fb41ae6ace 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](../../testdata/p4tc_samples). +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: From 06c0aa95445aa6883c6ff0b32ddcd1ab7d70d28f Mon Sep 17 00:00:00 2001 From: Adarsh Rawat Date: Fri, 15 Mar 2024 20:52:41 +0530 Subject: [PATCH 5/7] Add directory link for "examples" in "ubpf" Added directory link for examples directory in "ubpf" backend's Guide --- backends/ubpf/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/backends/ubpf/README.md b/backends/ubpf/README.md index 9296ef16cd..ad8d5f5ec3 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 [`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: From 13ee5813d409ecbbc5ed816a25fe9fb3eb76c5c4 Mon Sep 17 00:00:00 2001 From: Adarsh Rawat Date: Sat, 16 Mar 2024 22:06:32 +0530 Subject: [PATCH 6/7] [Fix] Formatting of directory name Co-authored-by: Fabian Ruffy <5960321+fruffy@users.noreply.github.com> --- backends/tc/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/backends/tc/README.md b/backends/tc/README.md index fb41ae6ace..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](../../testdata/p4tc_samples). +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: From d718cd954138ffd82655631f208fc513a289aeb0 Mon Sep 17 00:00:00 2001 From: Adarsh Rawat Date: Sat, 16 Mar 2024 22:10:06 +0530 Subject: [PATCH 7/7] [Fix] Add 'the' before 'example' in documentation Co-authored-by: Fabian Ruffy <5960321+fruffy@users.noreply.github.com> --- backends/ubpf/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/backends/ubpf/README.md b/backends/ubpf/README.md index ad8d5f5ec3..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](./examples). 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: