Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switching from Madoko to AsciiDoc for P4Runtime specification #510

Merged
merged 44 commits into from
Jan 19, 2025
Merged

Switching from Madoko to AsciiDoc for P4Runtime specification #510

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
4f8de37
Add reference for RFC2697 in bib
Dscano Aug 20, 2024
adcfbe9
Merge branch 'p4lang:main' into main
Dscano Oct 13, 2024
7659239
Merge branch 'p4lang:main' into main
Dscano Nov 11, 2024
780d780
Switching from Madoko to AsciiDoc for P4Runtime specification
Dscano Nov 16, 2024
c43d938
Addressed some comments in the PR
Dscano Nov 17, 2024
3d45a90
Addressed some comments in the PR, part 2
Dscano Nov 19, 2024
207dd87
Addressed some comments in the PR, part 3
Dscano Nov 19, 2024
f6703ed
Addressed some comments in the PR, part 4
Dscano Nov 21, 2024
ef538d6
Addressed some comments in the PR, part 5
Dscano Nov 23, 2024
4b9875f
Addressed some comments in the PR, part 6
Dscano Nov 23, 2024
dbbfe09
Addressed some comments in the PR, part 7
Dscano Nov 23, 2024
faf7275
Addressed some comments in the PR, part 8
Dscano Nov 24, 2024
4c48e1b
Removed trailing whitespace. Add lint script
Dscano Nov 24, 2024
4e277de
Changed caption table 7
Dscano Nov 24, 2024
36c2602
Fix tables caption
Dscano Nov 24, 2024
8f0f754
Proposal to address LibreOffice comment
Dscano Dec 2, 2024
7fbb83d
Implemented proposal (a) to update image and generate via LibreOffice
Dscano Dec 2, 2024
50b8bf5
Remove rogue version from Dockerfile.asciidoc
Dscano Dec 2, 2024
9eae1e4
Fix Dockerfile.asciidoc
Dscano Dec 2, 2024
6a58e48
README updated, and PNG, SVG images removed from the repo
Dscano Dec 7, 2024
d56cb14
Merge branch 'p4lang:main' into main
Dscano Dec 13, 2024
3d6caa4
Merge branch 'p4lang:main' into main
Dscano Dec 22, 2024
c0e0239
fix workflows yml
Dscano Dec 23, 2024
25118c6
fix Dockerfile.asciidoc
Dscano Dec 24, 2024
71bc292
Fix the Dockerfile.asciidoc by adding the time. Correct typos in READ…
Dscano Dec 24, 2024
c2355be
Address issue 528, used correct markup for em-dashes
Dscano Dec 24, 2024
02f0f21
Address issue 529, fix incorrect markup for creating links in Asciido…
Dscano Dec 24, 2024
37a06b1
Proposal issue 525, Some odd syntax highlighting in some code blocks
Dscano Dec 24, 2024
4360049
Fix trailing whitespace
Dscano Dec 24, 2024
f19f1b6
Fix trailing whitespace
Dscano Dec 24, 2024
8c06ca7
Proposal issue 524, fix PDF numbered lists
Dscano Dec 25, 2024
0ed60c4
Proposal issue 523, fix PDF to avoid breaking bullet items, titles an…
Dscano Dec 25, 2024
ce784a1
Fix issue 522, removed negative indentation
Dscano Dec 26, 2024
ba93b11
Fix issue 527, rendering of inline code improved
Dscano Dec 26, 2024
a93198f
Centered images and table captions in HTML
Dscano Dec 28, 2024
d9aea99
Add LibreOffice to the Dockerfile and include a new make command.
Dscano Dec 30, 2024
79ab44a
Suggest a make command
Dscano Dec 30, 2024
2fc304a
Add to Makefile png and svg images generation
Dscano Jan 5, 2025
8b9c162
Add images dependencies to Makefile
Dscano Jan 5, 2025
4182d31
Add a Makefile to locally generate the Docker image for AsciiDoc
Dscano Jan 10, 2025
5229d7c
Fix scep.yml
Dscano Jan 10, 2025
5779ce4
Fix scep.yml second tentative
Dscano Jan 10, 2025
8bc8f6b
Fix scep.yml removed ls
Dscano Jan 10, 2025
09eda6a
Add spec check in scep.yml
Dscano Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/spec.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ jobs:
- uses: actions/checkout@v3
- name: Build spec
run: |
docker run -v `pwd`/docs/v1:/usr/src/p4-spec p4lang/p4rt-asciidoc :latest make
docker run -v `pwd`/docs/v1:/usr/src/p4-spec p4lang/p4rt-asciidoc :latest make ci
ls docs/v1/build
3 changes: 2 additions & 1 deletion docs/tools/Dockerfile.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ LABEL description="Dockerfile used for building the asciidoc specification"
RUN apt-get update && \
apt-get install -y cmake flex bison libglib2.0-dev libcairo2-dev libpango1.0-dev libxml2-dev libwebp-dev libzstd-dev libgdk-pixbuf-2.0-dev time

RUN gem install asciidoctor && \
RUN apt-get install -y libreoffice && \
gem install asciidoctor && \
echo 'gem: --no-document' > /etc/gemrc && \
gem install nokogiri && \
gem install rghost && \
Expand Down
7 changes: 6 additions & 1 deletion docs/v1/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ ROUGE_CSS=style
all: ${SPEC}.pdf ${SPEC}.html

build:
mkdir -p build

${SPEC}.pdf: ${SPEC}.adoc
time asciidoctor-pdf -v \
Expand All @@ -23,5 +22,11 @@ ${SPEC}.html: ${SPEC}.adoc
-r asciidoctor-lists \
-a rouge-css=$(ROUGE_CSS) $<

images:
soffice --convert-to png --outdir resources/figs resources/figs/*.odg > /dev/null 2>&1
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

svg are also generated by the current docs/v1/Makefile. Are they no longer necessary with AsciiDoc PDF and HTML?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From my understanding, no. As you can see in the .adoc file, the figures used are PNGs."


ci: images all


clean:
/bin/rm -f ${SPEC}.pdf ${SPEC}.html
Loading