Skip to content

Commit 42b086e

Browse files
committed
Merge branch 'main' of https://github.com/zcash/zips into frost-randomizer
2 parents c74bed5 + 998a97f commit 42b086e

File tree

117 files changed

+13851
-2924
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

117 files changed

+13851
-2924
lines changed

.github/workflows/render.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ jobs:
1313
steps:
1414
- name: Checkout repository
1515
uses: actions/[email protected]
16-
with:
17-
token: ${{ secrets.CI_TOKEN }}
16+
# with:
17+
# token: ${{ secrets.CI_TOKEN }}
1818

1919
- name: Compile ZIPs and Zcash Protocol Specification
2020
uses: ./.github/actions/render

.gitignore

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,14 @@
1919
*.swp
2020
*.save
2121
*.save.*
22+
*~
23+
*.html.temp
2224

2325
.Makefile.uptodate
2426
.zipfilelist.*
2527
.draftfilelist.*
2628

27-
protocol/aux/
28-
protocol/html/
29-
protocol/saplinghtml/
29+
MultiMarkdown-6
3030

31-
protocol/heartwood.pdf
31+
protocol/aux/
3232
protocol/protocol.ver
33-
*~

Dockerfile

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@ FROM debian:latest
22

33
RUN apt-get update
44
RUN apt-get install -y \
5-
gawk \
65
perl \
76
sed \
87
git \
8+
cmake \
99
python3 \
1010
python3-pip \
1111
pandoc \
@@ -18,7 +18,12 @@ RUN apt-get install -y \
1818
texlive-bibtex-extra
1919

2020
RUN rm /usr/lib/python3.11/EXTERNALLY-MANAGED
21-
RUN pip install rst2html5
21+
RUN pip install 'docutils==0.21.2' 'rst2html5==2.0.1'
22+
23+
RUN git config --global --add safe.directory /zips
24+
25+
# Use a fork so that we're running pinned code.
26+
RUN git clone -b develop https://github.com/Electric-Coin-Company/MultiMarkdown-6 && cd MultiMarkdown-6 && make release && cd build && make && make install
2227

2328
ENV PATH=${PATH}:/root/.local/bin
2429

Makefile

Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
# Dependencies: see zip-guide.rst and protocol/README.rst
1+
# Dependencies: see zips/zip-guide.rst and protocol/README.rst
22

3-
.PHONY: all all-zips tag-release protocol discard
3+
MARKDOWN_OPTION?=--mmd
4+
5+
.PHONY: all-zips all tag-release protocol all-protocol discard
46
all-zips: .Makefile.uptodate
57
echo "$(patsubst zips/%,%,$(sort $(wildcard zips/zip-*.rst) $(wildcard zips/zip-*.md)))" >.zipfilelist.new
68
diff .zipfilelist.current .zipfilelist.new || cp -f .zipfilelist.new .zipfilelist.current
@@ -11,50 +13,49 @@ all-zips: .Makefile.uptodate
1113
$(MAKE) README.rst
1214
$(MAKE) rendered/index.html $(addprefix rendered/,$(addsuffix .html,$(basename $(patsubst zips/%,%,$(sort $(wildcard zips/*.rst) $(wildcard zips/*.md))))))
1315

14-
all: all-zips protocol
16+
all: all-zips all-protocol
1517

1618
tag-release:
1719
$(MAKE) -C protocol tag-release
1820

1921
protocol:
20-
$(MAKE) -C protocol
22+
$(MAKE) -C protocol protocol
23+
24+
protocol-dark:
25+
$(MAKE) -C protocol protocol-dark
26+
27+
all-protocol:
28+
$(MAKE) -C protocol all
29+
30+
all-specs: all-zips
31+
$(MAKE) -C protocol all-specs
2132

2233
discard:
2334
git checkout -- 'rendered/*.html' 'README.rst' 'rendered/protocol/*.pdf'
2435

25-
.Makefile.uptodate: Makefile edithtml.sh
36+
.Makefile.uptodate: Makefile render.sh
2637
$(MAKE) clean
2738
touch .Makefile.uptodate
2839

29-
define PROCESSRST
30-
$(eval TITLE := $(shell echo '$(patsubst zips/%,%,$(basename $<))' | sed -E 's|zip-0{0,3}|ZIP |;s|draft-|Draft |')$(shell grep -E '^(\.\.)?\s*Title: ' $< |sed -E 's|.*Title||'))
31-
rst2html5 -v --title="$(TITLE)" $< >$@
32-
./edithtml.sh --rst $@
33-
endef
40+
rendered/index.html: README.rst render.sh
41+
./render.sh --rst $< $@
3442

35-
define PROCESSMD
36-
$(eval TITLE := $(shell echo '$(patsubst zips/%,%,$(basename $<))' | sed -E 's|zip-0{0,3}|ZIP |;s|draft-|Draft |')$(shell grep -E '^(\.\.)?\s*Title: ' $< |sed -E 's|.*Title||'))
37-
pandoc --from=markdown --to=html $< --output=$@
38-
./edithtml.sh --md $@ "${TITLE}"
39-
endef
43+
rendered/%.html: zips/%.rst render.sh
44+
./render.sh --rst $< $@
4045

41-
rendered/index.html: README.rst edithtml.sh
42-
$(PROCESSRST)
43-
44-
rendered/%.html: zips/%.rst edithtml.sh
45-
$(PROCESSRST)
46-
47-
rendered/%.html: zips/%.md edithtml.sh
48-
$(PROCESSMD)
46+
rendered/%.html: zips/%.md render.sh
47+
./render.sh $(MARKDOWN_OPTION) $< $@
4948

5049
README.rst: .zipfilelist.current .draftfilelist.current makeindex.sh README.template $(wildcard zips/zip-*.rst) $(wildcard zips/zip-*.md) $(wildcard zips/draft-*.rst) $(wildcard zips/draft-*.md)
5150
./makeindex.sh | cat README.template - >README.rst
5251

53-
.PHONY: linkcheck
54-
linkcheck: all-zips
55-
$(MAKE) -C protocol all-specs
56-
./links_and_dests.py --check $(filter-out $(wildcard rendered/draft-*.html),$(wildcard rendered/*.html)) rendered/protocol/protocol.pdf rendered/protocol/canopy.pdf rendered/protocol/heartwood.pdf rendered/protocol/blossom.pdf rendered/protocol/sapling.pdf
52+
.PHONY: linkcheck clean all-clean
53+
linkcheck: all
54+
./links_and_dests.py --check $(filter-out $(wildcard rendered/draft-*.html),$(wildcard rendered/*.html)) $(filter-out rendered/protocol/sprout.pdf,$(wildcard rendered/protocol/*.pdf))
5755

58-
.PHONY: clean
5956
clean:
6057
rm -f .zipfilelist.* README.rst rendered/index.html $(addprefix rendered/,$(addsuffix .html,$(basename $(patsubst zips/%,%,$(sort $(wildcard zips/*.rst) $(wildcard zips/*.md))))))
58+
59+
all-clean:
60+
$(MAKE) clean
61+
$(MAKE) -C protocol clean

0 commit comments

Comments
 (0)