Skip to content

Commit

Permalink
Addressed some comments in the PR, part 6
Browse files Browse the repository at this point in the history
Signed-off-by: Davide Scano <[email protected]>
  • Loading branch information
Dscano committed Nov 23, 2024
1 parent ef538d6 commit 4b9875f
Show file tree
Hide file tree
Showing 15 changed files with 94 additions and 1,158 deletions.
7 changes: 3 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,9 @@ You can fork the repo and submit a pull request in Github.

All developers must have signed the [P4.org](http://p4.org) CLA.

### Madoko style checker
### AsciiDoc style checker

The P4Runtime specification is written using
[Madoko](http://madoko.org/reference.html). We provide a lint tool to catch
[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/madokolint.py`.
run as part of CI and patches cannot be merged until it returns success.
5 changes: 2 additions & 3 deletions docs/v1/Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

SPEC=P4Runtime-Spec

ROUGE_STYLE=github
Expand Down Expand Up @@ -26,8 +25,8 @@ ${SPEC}.html: ${SPEC}.adoc figs
time asciidoctor -v \
-r asciidoctor-mathematical \
-r asciidoctor-bibtex \
-r asciidoctor-lists \
-r asciidoctor-lists \
-a rouge-css=$(ROUGE_CSS) $<

clean:
/bin/rm -f ${SPEC}.pdf ${SPEC}.html resources/figs/stem-*.png
/bin/rm -f ${SPEC}.pdf ${SPEC}.html resources/figs/stem-*.png
Loading

0 comments on commit 4b9875f

Please sign in to comment.