From 1fc826aa43b489426610312166554e51fbd7b861 Mon Sep 17 00:00:00 2001 From: pranagupt <31817556+pranagupt@users.noreply.github.com> Date: Mon, 29 Nov 2021 22:26:31 +0530 Subject: [PATCH] add links to docs for v1model and others in README's (#391) * add links to docs for v1model and others in README's * Improve documentation sections in READMEs --- README.md | 8 ++++++++ exercises/basic/README.md | 7 +++++++ exercises/basic_tunnel/README.md | 7 +++++++ exercises/calc/README.md | 10 +++++++++- exercises/ecn/README.md | 7 +++++++ exercises/firewall/README.md | 7 +++++++ exercises/link_monitor/README.md | 7 +++++++ exercises/load_balance/README.md | 8 ++++++++ exercises/mri/README.md | 8 ++++++++ exercises/multicast/README.md | 8 ++++++++ exercises/p4runtime/README.md | 8 ++++++++ exercises/qos/README.md | 8 ++++++++ exercises/source_routing/README.md | 9 +++++++++ 13 files changed, 101 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 776d974..77546ef 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,14 @@ in the P4_tutorial.pdf in the tutorial directory. A P4 Cheat Sheet is also available [online](https://drive.google.com/file/d/1Z8woKyElFAOP6bMd8tRa_Q4SA1cd_Uva/view?usp=sharing) which contains various examples that you can refer to. + +## P4 Documentation + +The documentation for P4_16 and P4Runtime is available [here](https://p4.org/specs/) + +All excercises in this repository use the v1model architecture, the documentation for which is available at: +1. The BMv2 Simple Switch target document accessible [here](https://github.com/p4lang/behavioral-model/blob/master/docs/simple_switch.md) talks mainly about the v1model architecture. +2. The include file `v1model.p4` has extensive comments and can be accessed [here](https://github.com/p4lang/p4c/blob/master/p4include/v1model.p4). ## Obtaining required software diff --git a/exercises/basic/README.md b/exercises/basic/README.md index dd077cc..b9e85bf 100644 --- a/exercises/basic/README.md +++ b/exercises/basic/README.md @@ -170,3 +170,10 @@ these instances: make stop ``` +## Relevant Documentation + +The documentation for P4_16 and P4Runtime is available [here](https://p4.org/specs/) + +All excercises in this repository use the v1model architecture, the documentation for which is available at: +1. The BMv2 Simple Switch target document accessible [here](https://github.com/p4lang/behavioral-model/blob/master/docs/simple_switch.md) talks mainly about the v1model architecture. +2. The include file `v1model.p4` has extensive comments and can be accessed [here](https://github.com/p4lang/p4c/blob/master/p4include/v1model.p4). \ No newline at end of file diff --git a/exercises/basic_tunnel/README.md b/exercises/basic_tunnel/README.md index 0d3a769..c6aff32 100644 --- a/exercises/basic_tunnel/README.md +++ b/exercises/basic_tunnel/README.md @@ -187,3 +187,10 @@ make stop Congratulations, your implementation works! Move onto the next assignment [p4runtime](../p4runtime)! +## Relevant Documentation + +The documentation for P4_16 and P4Runtime is available [here](https://p4.org/specs/) + +All excercises in this repository use the v1model architecture, the documentation for which is available at: +1. The BMv2 Simple Switch target document accessible [here](https://github.com/p4lang/behavioral-model/blob/master/docs/simple_switch.md) talks mainly about the v1model architecture. +2. The include file `v1model.p4` has extensive comments and can be accessed [here](https://github.com/p4lang/p4c/blob/master/p4include/v1model.p4). diff --git a/exercises/calc/README.md b/exercises/calc/README.md index d827287..a4c9d7c 100644 --- a/exercises/calc/README.md +++ b/exercises/calc/README.md @@ -104,4 +104,12 @@ correct result: > 1+1 2 > -``` \ No newline at end of file +``` + +## Relevant Documentation + +The documentation for P4_16 and P4Runtime is available [here](https://p4.org/specs/) + +All excercises in this repository use the v1model architecture, the documentation for which is available at: +1. The BMv2 Simple Switch target document accessible [here](https://github.com/p4lang/behavioral-model/blob/master/docs/simple_switch.md) talks mainly about the v1model architecture. +2. The include file `v1model.p4` has extensive comments and can be accessed [here](https://github.com/p4lang/p4c/blob/master/p4include/v1model.p4). \ No newline at end of file diff --git a/exercises/ecn/README.md b/exercises/ecn/README.md index 59f0b02..fbf0f24 100644 --- a/exercises/ecn/README.md +++ b/exercises/ecn/README.md @@ -190,3 +190,10 @@ these instances: ```bash make stop ``` +## Relevant Documentation + +The documentation for P4_16 and P4Runtime is available [here](https://p4.org/specs/) + +All excercises in this repository use the v1model architecture, the documentation for which is available at: +1. The BMv2 Simple Switch target document accessible [here](https://github.com/p4lang/behavioral-model/blob/master/docs/simple_switch.md) talks mainly about the v1model architecture. +2. The include file `v1model.p4` has extensive comments and can be accessed [here](https://github.com/p4lang/p4c/blob/master/p4include/v1model.p4). \ No newline at end of file diff --git a/exercises/firewall/README.md b/exercises/firewall/README.md index c91ebfe..3bfe22c 100644 --- a/exercises/firewall/README.md +++ b/exercises/firewall/README.md @@ -213,3 +213,10 @@ these instances: make stop ``` +## Relevant Documentation + +The documentation for P4_16 and P4Runtime is available [here](https://p4.org/specs/) + +All excercises in this repository use the v1model architecture, the documentation for which is available at: +1. The BMv2 Simple Switch target document accessible [here](https://github.com/p4lang/behavioral-model/blob/master/docs/simple_switch.md) talks mainly about the v1model architecture. +2. The include file `v1model.p4` has extensive comments and can be accessed [here](https://github.com/p4lang/p4c/blob/master/p4include/v1model.p4). \ No newline at end of file diff --git a/exercises/link_monitor/README.md b/exercises/link_monitor/README.md index e5086b1..288e753 100644 --- a/exercises/link_monitor/README.md +++ b/exercises/link_monitor/README.md @@ -225,3 +225,10 @@ within the core of the network? For instance, how might you use this data, either at the hosts or at the switches, to make real-time load-balancing decisions? +## Relevant Documentation + +The documentation for P4_16 and P4Runtime is available [here](https://p4.org/specs/) + +All excercises in this repository use the v1model architecture, the documentation for which is available at: +1. The BMv2 Simple Switch target document accessible [here](https://github.com/p4lang/behavioral-model/blob/master/docs/simple_switch.md) talks mainly about the v1model architecture. +2. The include file `v1model.p4` has extensive comments and can be accessed [here](https://github.com/p4lang/p4c/blob/master/p4include/v1model.p4). \ No newline at end of file diff --git a/exercises/load_balance/README.md b/exercises/load_balance/README.md index 6e75802..3a2fde0 100644 --- a/exercises/load_balance/README.md +++ b/exercises/load_balance/README.md @@ -130,3 +130,11 @@ mn -c ## Next Steps Congratulations, your implementation works! Move on to [Multi-Hop Route Inspection](../mri). + +## Relevant Documentation + +The documentation for P4_16 and P4Runtime is available [here](https://p4.org/specs/) + +All excercises in this repository use the v1model architecture, the documentation for which is available at: +1. The BMv2 Simple Switch target document accessible [here](https://github.com/p4lang/behavioral-model/blob/master/docs/simple_switch.md) talks mainly about the v1model architecture. +2. The include file `v1model.p4` has extensive comments and can be accessed [here](https://github.com/p4lang/p4c/blob/master/p4include/v1model.p4). \ No newline at end of file diff --git a/exercises/mri/README.md b/exercises/mri/README.md index 1e4be01..7f1281b 100644 --- a/exercises/mri/README.md +++ b/exercises/mri/README.md @@ -245,3 +245,11 @@ make stop Congratulations, your implementation works! Move on to [Source Routing](../source_routing). + +## Relevant Documentation + +The documentation for P4_16 and P4Runtime is available [here](https://p4.org/specs/) + +All excercises in this repository use the v1model architecture, the documentation for which is available at: +1. The BMv2 Simple Switch target document accessible [here](https://github.com/p4lang/behavioral-model/blob/master/docs/simple_switch.md) talks mainly about the v1model architecture. +2. The include file `v1model.p4` has extensive comments and can be accessed [here](https://github.com/p4lang/p4c/blob/master/p4include/v1model.p4). \ No newline at end of file diff --git a/exercises/multicast/README.md b/exercises/multicast/README.md index a7e8c99..e8931b1 100644 --- a/exercises/multicast/README.md +++ b/exercises/multicast/README.md @@ -154,3 +154,11 @@ these instances: ```bash make stop ``` + +## Relevant Documentation + +The documentation for P4_16 and P4Runtime is available [here](https://p4.org/specs/) + +All excercises in this repository use the v1model architecture, the documentation for which is available at: +1. The BMv2 Simple Switch target document accessible [here](https://github.com/p4lang/behavioral-model/blob/master/docs/simple_switch.md) talks mainly about the v1model architecture. +2. The include file `v1model.p4` has extensive comments and can be accessed [here](https://github.com/p4lang/p4c/blob/master/p4include/v1model.p4). \ No newline at end of file diff --git a/exercises/p4runtime/README.md b/exercises/p4runtime/README.md index 968e589..75a9b84 100644 --- a/exercises/p4runtime/README.md +++ b/exercises/p4runtime/README.md @@ -186,3 +186,11 @@ solution/my_controller.py Congratulations, your implementation works! Move onto the next assignment [mri](../mri)! + +## Relevant Documentation + +The documentation for P4_16 and P4Runtime is available [here](https://p4.org/specs/) + +All excercises in this repository use the v1model architecture, the documentation for which is available at: +1. The BMv2 Simple Switch target document accessible [here](https://github.com/p4lang/behavioral-model/blob/master/docs/simple_switch.md) talks mainly about the v1model architecture. +2. The include file `v1model.p4` has extensive comments and can be accessed [here](https://github.com/p4lang/p4c/blob/master/p4include/v1model.p4). \ No newline at end of file diff --git a/exercises/qos/README.md b/exercises/qos/README.md index 8b62c7d..6cdad6e 100644 --- a/exercises/qos/README.md +++ b/exercises/qos/README.md @@ -164,3 +164,11 @@ these instances: ```bash make stop ``` + +## Relevant Documentation + +The documentation for P4_16 and P4Runtime is available [here](https://p4.org/specs/) + +All excercises in this repository use the v1model architecture, the documentation for which is available at: +1. The BMv2 Simple Switch target document accessible [here](https://github.com/p4lang/behavioral-model/blob/master/docs/simple_switch.md) talks mainly about the v1model architecture. +2. The include file `v1model.p4` has extensive comments and can be accessed [here](https://github.com/p4lang/p4c/blob/master/p4include/v1model.p4). \ No newline at end of file diff --git a/exercises/source_routing/README.md b/exercises/source_routing/README.md index 34c4f7c..71493f6 100644 --- a/exercises/source_routing/README.md +++ b/exercises/source_routing/README.md @@ -145,3 +145,12 @@ mn -c Congratulations, your implementation works! Move on to [Load Balance](../load_balance). + + +## Relevant Documentation + +The documentation for P4_16 and P4Runtime is available [here](https://p4.org/specs/) + +All excercises in this repository use the v1model architecture, the documentation for which is available at: +1. The BMv2 Simple Switch target document accessible [here](https://github.com/p4lang/behavioral-model/blob/master/docs/simple_switch.md) talks mainly about the v1model architecture. +2. The include file `v1model.p4` has extensive comments and can be accessed [here](https://github.com/p4lang/p4c/blob/master/p4include/v1model.p4). \ No newline at end of file