From f881cf7c482de4f0890676b1abc5d7e94d69cce7 Mon Sep 17 00:00:00 2001 From: Devansh-567 Date: Wed, 1 Jul 2026 11:07:14 +0530 Subject: [PATCH] docs: fix contributor-facing typos and stale links Signed-off-by: Devansh-567 --- CONTRIBUTING.md | 2 +- README.md | 8 ++++---- docs/README.md | 8 ++++---- docs/tools/README.md | 2 +- docs/v1/README.md | 8 ++++---- docs/v1/guidance-for-generating-p4info.md | 2 +- docs/v1/p4runtime-id-notes.md | 2 +- rust/README.md | 2 +- 8 files changed, 17 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1265c746..276995dc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ SPDX-FileCopyrightText: 2019 Antonin Bas SPDX-License-Identifier: Apache-2.0 --> -You can fork the repo and submit a pull request in Github. +You can fork the repo and submit a pull request in GitHub. ### Apache CLA diff --git a/README.md b/README.md index 3f55031d..9b631823 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ P4Runtime follows [semantic versioning](https://semver.org/). We use git tags of them form `v1.4.1` to mark all releases. Starting from `v1.5.0`, we also use release branches of the form `v1.5.x` to track minor releases. -## Github Pages +## GitHub Pages We maintain a `gh-pages` [branch](https://github.com/p4lang/p4runtime/tree/gh-pages) to host all releases of the specification, available at https://p4lang.github.io/p4runtime/. @@ -205,9 +205,9 @@ definitions, only advice written by those with experience in using protobuf for applications while they have been extended over time. They are here for learning and reference: -* [Updating Proto Definitions Without Updating Code](https://developers.google.com/protocol-buffers/docs/overview#updating-defs) -* [Updating A Message Type](https://developers.google.com/protocol-buffers/docs/proto3#updating) -* [Backwards-compatibility issues in `oneof` fields](https://developers.google.com/protocol-buffers/docs/proto3#backwards-compatibility_issues) +* [Updating Proto Definitions Without Updating Code](https://protobuf.dev/overview/#updating-defs) +* [Updating A Message Type](https://protobuf.dev/programming-guides/proto3/#updating) +* [Backwards-compatibility issues in `oneof` fields](https://protobuf.dev/programming-guides/proto3/#backward) * [API design guide](https://cloud.google.com/apis/design) Some brief points, but not the full story: diff --git a/docs/README.md b/docs/README.md index a4254ae7..11cce3d2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -39,7 +39,7 @@ Use `-` for the hyphen, `--` for en dash and `—` for em dash. Each image in the specification has a corresponding `.odg` file in `resources/figs/`. These are LibreOffice drawing files. The files are rendered into -`.svg` and `.png` images (for HTML and PDF output, resepectively) at build time, +`.svg` and `.png` images (for HTML and PDF output, respectively) at build time, using the `soffice` command-line tool. The page size for each image should be adjusted manually by the author ("artist") to just fit the image on the apparent "page," to minimize padding around the image in the rendered @@ -50,9 +50,9 @@ change the object's aspect ratio.) ## CI upload of built documents -Github Actions take care of uploading the built HTML version of the spec to -Github. The latest working draft (main branch) can be found -[here](https://p4.org/p4runtime/spec/main/P4Runtime-Spec.html). +GitHub Actions take care of uploading the built HTML version of the spec to +GitHub Pages. The latest working draft (main branch) can be found +[here](https://p4lang.github.io/p4runtime/spec/main/P4Runtime-Spec.html). Additionally, you can access the HTML & PDF versions of the spec for any given branch of this repository by using the following URLs: diff --git a/docs/tools/README.md b/docs/tools/README.md index f8b5c13f..41f30d2a 100644 --- a/docs/tools/README.md +++ b/docs/tools/README.md @@ -13,7 +13,7 @@ Only maintainers of this repository need to build the Docker image when a new image needs to be pushed to dockerhub. Contributors to the specification can simply pull the image from dockerhub and don't have to worry about building the image themselves. If you are a maintainer and you need to upload a new version -of the Docker image to to dockerhub, you will need the following commands: +of the Docker image to dockerhub, you will need the following commands: ```bash docker build -t p4rt-asciidoc -f Dockerfile.asciidoc . docker tag p4rt-asciidoc p4lang/p4rt-asciidoc:latest diff --git a/docs/v1/README.md b/docs/v1/README.md index 689ab717..c982f71f 100644 --- a/docs/v1/README.md +++ b/docs/v1/README.md @@ -14,7 +14,7 @@ specification document. The markup version uses [AsciiDoc](https://docs.asciidoctor.org/) to produce HTML and PDF versions of the documentation. Pre-built versions of the documentation are available on the [P4.org specifications -page](https://p4.org/specs). +page](https://p4.org/specifications/). Files: @@ -42,10 +42,10 @@ You need to install [LibreOffice](https://nl.libreoffice.org/) on your local mac Each image in the specification has a corresponding `.odg` file under `resources/figs/`. These are LibreOffice drawing files. The files are rendered into -`.svg` and `.png` images (for HTML and PDF output, resepectively) at build time, +`.svg` and `.png` images (for HTML and PDF output, respectively) at build time, using the `soffice` command-line tool. The page size for each image should be adjusted manually by the author ("artist") to just fit the image on the -apparrent "page," to minimize padding around the image in the rendered +apparent "page," to minimize padding around the image in the rendered document. Use the menu item `Format | Page/Size Properties.` See the example screen shot below. (Do not check the "Fit object to paper format" box - it will change the object's aspect ratio.) @@ -72,7 +72,7 @@ LibreOffice to be installed. ## Building The easiest way to render the AsciiDoc specification documentation is to use the -`p4lang/p4rt-asciidoc:latest` Docker` image: +`p4lang/p4rt-asciidoc:latest` Docker image: docker run -v `pwd`/docs/v1:/usr/src/p4-spec p4lang/p4rt-asciidoc:latest make build_spec_with_images diff --git a/docs/v1/guidance-for-generating-p4info.md b/docs/v1/guidance-for-generating-p4info.md index 02425af4..18b1f147 100644 --- a/docs/v1/guidance-for-generating-p4info.md +++ b/docs/v1/guidance-for-generating-p4info.md @@ -143,7 +143,7 @@ rules: * if `` is `n`, where `n` is a positive integer, then the `bitwidth` field should be assigned the value `n` - * if `` is `bit`, where `W` is a postive integer, then the + * if `` is `bit`, where `W` is a positive integer, then the `bitwidth` field should be assigned value `W` * if `` is `string`, then the `bitwidth` field should be unset (which in Protobuf version 3 is the same as setting it explicitly to diff --git a/docs/v1/p4runtime-id-notes.md b/docs/v1/p4runtime-id-notes.md index eb6a7d98..6888b1a6 100644 --- a/docs/v1/p4runtime-id-notes.md +++ b/docs/v1/p4runtime-id-notes.md @@ -186,7 +186,7 @@ message type names do not conflict with each other. | `register_id` | `RegisterEntry` | `Register` | | | `digest_id` | `DigestEntry` | `Digest` | `DigestEntry` messages are used to configure a `Digest` object as a whole, not to deal with digest messages. | | `digest_id` | `DigestList` | `Digest` | `DigestList` messages are sent by a server to a client, to report a list of digest messages generated by a P4 device. | -| `digest_id` | `DigestListAck` | `Digest` | `DigestListAck` mssages are sent by a client to acknowledge an earlier `DigestList` message that it received. | +| `digest_id` | `DigestListAck` | `Digest` | `DigestListAck` messages are sent by a client to acknowledge an earlier `DigestList` message that it received. | | `extern_id` | `ExternEntry` | `ExternInstance` | | | `metadata_id` | `PacketMetadata` sub-message of `PacketIn` (or `PacketOut`) | `Metadata` sub-message of `ControllerPacketMetadata` | Refers to a `Metadata` message in the `ControllerPacketMetadata` object whose name is `packet_in` (or `packet_out`). | | `action_profile_id` | `ActionProfileMember` | `ActionProfile` | `ActionProfileMember` messages may reference an `ActionProfile` object with `with_selector` equal to true or false, i.e. either an action selector or an action profile object | diff --git a/rust/README.md b/rust/README.md index 03b4dcd8..fca5392d 100644 --- a/rust/README.md +++ b/rust/README.md @@ -85,7 +85,7 @@ Simply run cargo doc --open ``` to build documentation for the crates and bring it up in your default web -browser. Then, navgiate to the desired object and click "Source". +browser. Then, navigate to the desired object and click "Source". ### Using cargo outdir