Skip to content

Commit

Permalink
Removed trailing whitespace. Add lint script
Browse files Browse the repository at this point in the history
Signed-off-by: Davide Scano <[email protected]>
  • Loading branch information
Dscano committed Nov 24, 2024
1 parent faf7275 commit 4c48e1b
Show file tree
Hide file tree
Showing 5 changed files with 485 additions and 133 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/spec.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
- uses: actions/checkout@v3
- name: Run linter
run: |
./tools/asciidoc lint.py docs/v1/P4Runtime-Spec.adoc
./tools/asciidoclint.py docs/v1/P4Runtime-Spec.adoc
build-spec:
runs-on: [ubuntu-latest]
Expand Down
5 changes: 4 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,7 @@ All developers must have signed the [P4.org](http://p4.org) CLA.

### AsciiDoc style checker

The P4Runtime specification is written using [AsciiDoc](https://docs.asciidoctor.org/).
The P4Runtime specification is written using [AsciiDoc](https://docs.asciidoctor.org/).
We provide a lint tool to catch basic formatting issues and try to keep the spec uniform.
The lint tool will be run as part of CI and patches cannot be merged until it returns success. You can
run the lint tool locally with `./tools/asciidoclint.py`.
Loading

0 comments on commit 4c48e1b

Please sign in to comment.