Skip to content

Commit

Permalink
Minor Fix: links in P4Smith page (p4lang#4828)
Browse files Browse the repository at this point in the history
* Fix: links in P4Smith page

Signed-off-by: Adarsh <[email protected]>

* Docs : Convert absolute links to relative links

This change ensures that the generated documents refer to the correct sections within the documents themselves, instead of redirecting users to GitHub.

Signed-off-by: Adarsh <[email protected]>

---------

Signed-off-by: Adarsh <[email protected]>
  • Loading branch information
AdarshRawat1 authored Jul 23, 2024
1 parent a2ce60f commit 132122d
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ To sign off the last commit quickly use the `git commit --amend --signoff` comma
Please note that this project adheres to the [P4 Coding Standard Philosophy](docs/CodingStandardPhilosophy.md). By participating, you are expected to uphold this code.

## How to Contribute
We welcome and appreciate new contributions. Check out [git usage](https://github.com/p4lang/p4c/tree/main/docs#git-usage) to get started.
We welcome and appreciate new contributions. Check out [git usage](docs/README.md#git-usage) to get started.

### Guidelines

* Writing unit test code [Guidelines](https://github.com/p4lang/p4c/tree/main/docs#adding-new-test-data).
* Write documentation [Guidelines](https://github.com/p4lang/p4c/tree/main/docs#writing-documentation).
* [Coding conventions](https://github.com/p4lang/p4c/tree/main/docs#coding-conventions).
* Opening pull requests and writing commit messages [Guidelines](https://github.com/p4lang/p4c/blob/main/docs/CodingStandardPhilosophy.md#Git-commits-and-pull-requests).
* Writing unit test code [Guidelines](docs/README.md#adding-new-test-data).
* Write documentation [Guidelines](docs/README.md#writing-documentation).
* [Coding conventions](docs/README.md#coding-conventions).
* Opening pull requests and writing commit messages [Guidelines](docs/CodingStandardPhilosophy.md#Git-commits-and-pull-requests).
* Code has to be reviewed before it is merged.
* Make sure all tests pass when you send a pull request.
* Participate in the code review process and address any feedback or comments.
Expand Down
8 changes: 4 additions & 4 deletions backends/p4tools/modules/smith/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,22 +24,22 @@ P4Smith is available as part of the [official P4C docker image](https://hub.dock
P4Smith extensions are instantiations of a particular combination of P4 architecture and the target that executes the P4 code. For example, the `v1model.p4` architecture can be executed on the behavioral model. P4Smith extension make use of the core P4Smith framework to generate programs. Several open-source extensions are available.

### core.p4 using the test compiler p4test
[targets/generic](targets/generic)
[targets/generic](https://github.com/p4lang/p4c/tree/main/backends/p4tools/modules/smith/targets/generic)

This random program generator generates random packages and tries to produce all valid P4 code according to the latest P4 specification. Programs should be compiled using [p4test](https://github.com/p4lang/p4c/tree/main/backends/p4est).

### v1model.p4 and psa.p4 on BMv2
[targets/bmv2](targets/bmv2)
[targets/bmv2](https://github.com/p4lang/p4c/tree/main/backends/p4tools/modules/smith/targets/bmv2)

P4Smith supports generating P4 programs for the `v1model` and `psa` architecture on [BMv2](https://github.com/p4lang/behavioral-model).

### pna.p4 on the DPDK SoftNIC
[targets/fpga](targets/nic)
[targets/fpga](https://github.com/p4lang/p4c/tree/main/backends/p4tools/modules/smith/targets/nic)

The [DPDK-SoftNIC](https://github.com/p4lang/p4-dpdk-target) is a new target implemented using the [Data Plane Development Kit (DPDK)](https://www.dpdk.org/). The SoftNIC can be programmed using the P4 `pna.p4` architecture.

### tna.p4 on Tofino 1
[targets/tna](targets/tofino)
[targets/tna](https://github.com/p4lang/p4c/tree/main/backends/p4tools/modules/smith/targets/tofino)

P4Smith can also generate programs for the `tna` architecture on Tofino 1. The programs are intended to be compiled on the proprietary Barefoot Tofino compiler.

Expand Down

0 comments on commit 132122d

Please sign in to comment.