Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[documentation] Add hyperlinks to the actual directory in the README file. #4531

Merged
merged 9 commits into from
Mar 16, 2024
Merged

[documentation] Add hyperlinks to the actual directory in the README file. #4531

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7cb3ad4
Add directory link for examples in DPDK
AdarshRawat1 Mar 14, 2024
9bf2397
[Docs] Add Directory link for p4tc_samples
AdarshRawat1 Mar 14, 2024
809493e
Merge branch 'main' into Docs-5-minor-Accessibility-fixes
AdarshRawat1 Mar 15, 2024
f92ee8a
Add "examples" to link text
AdarshRawat1 Mar 15, 2024
bd6a7f1
Add "testdata/p4tc_samples" to link text
AdarshRawat1 Mar 15, 2024
06c0aa9
Add directory link for "examples" in "ubpf"
AdarshRawat1 Mar 15, 2024
13ee581
[Fix] Formatting of directory name
AdarshRawat1 Mar 16, 2024
d718cd9
[Fix] Add 'the' before 'example' in documentation
AdarshRawat1 Mar 16, 2024
d9fe14d
Merge branch 'main' into Docs-5-minor-Accessibility-fixes
AdarshRawat1 Mar 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion backends/dpdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion backends/tc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion backends/ubpf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading