doc, wiregen: use SHA256 stamps instead of git versions.

This should be more robust in future: we SHA256 all of the deps. For wiregen we prefix with EXPERIMENTAL_FEATURES, since it can effect them. Signed-off-by: Rusty Russell <[email protected]>
leshik · Sep 1, 2020 · a00179d · a00179d
1 parent 71e713c
commit a00179d
Show file tree

Hide file tree

Showing 52 changed files with 66 additions and 11 deletions.
diff --git a/Makefile b/Makefile
@@ -200,7 +200,9 @@ CDUMP_OBJS := ccan-cdump.o ccan-strmap.o
 
 BOLT_GEN := tools/generate-wire.py
 WIRE_GEN := $(BOLT_GEN)
-BOLT_DEPS := $(BOLT_GEN)
+
+# If you use wiregen, you're dependent on the tool, its templates, and Makefile
+WIRE_GEN_DEPS := $(WIRE_GEN) Makefile $(wildcard tools/gen/*_template)
 
 ALL_PROGRAMS =
 
@@ -247,12 +249,19 @@ config.vars:
 %.o: %.c
 	@$(call VERBOSE, "cc $<", $(CC) $(CFLAGS) -c -o $@ $<)
 
+# Git doesn't maintain timestamps, so we only regen if sources actually changed:
+# We place the SHA inside some generated files so we can tell if they need updating.
+# Usage: $(call SHA256STAMP_CHANGED,prefix)
+SHA256STAMP_CHANGED = [ x"`sed -n 's/.*SHA256STAMP://p' $@ 2>/dev/null`" != x"$(1)`cat $^ | sha256sum | cut -c1-64`" ]
+# Usage: $(call SHA256STAMP,prefix,commentprefix)
+SHA256STAMP = echo '$(2) SHA256STAMP:$(1)'`cat $^ | sha256sum | cut -c1-64` >> $@
+
 # generate-wire.py --page [header|impl] hdrfilename wirename < csv > file
-%_wiregen.h: %_wire.csv
-	@if $(CHANGED_FROM_GIT); then $(call VERBOSE,"wiregen $@",tools/generate-wire.py --page header $($@_args) $@ `basename $< .csv` < $< > $@); fi
+%_wiregen.h: %_wire.csv $(WIRE_GEN_DEPS)
+	@if $(call SHA256STAMP_CHANGED,exp-$(EXPERIMENTAL_FEATURES)-); then $(call VERBOSE,"wiregen $@",tools/generate-wire.py --page header $($@_args) $@ `basename $< .csv` < $< > $@ && $(call SHA256STAMP,exp-$(EXPERIMENTAL_FEATURES)-,//)); fi
 
-%_wiregen.c: %_wire.csv
-	@if $(CHANGED_FROM_GIT); then $(call VERBOSE,"wiregen $@",tools/generate-wire.py --page impl $($@_args) ${@:.c=.h} `basename $< .csv` < $< > $@); fi
+%_wiregen.c: %_wire.csv $(WIRE_GEN_DEPS)
+	@if $(call SHA256STAMP_CHANGED,exp-$(EXPERIMENTAL_FEATURES)-); then $(call VERBOSE,"wiregen $@",tools/generate-wire.py --page impl $($@_args) ${@:.c=.h} `basename $< .csv` < $< > $@ && $(call SHA256STAMP,exp-$(EXPERIMENTAL_FEATURES)-,//)); fi
 
 include external/Makefile
 include bitcoin/Makefile
@@ -282,10 +291,6 @@ gen_list_of_builtin_plugins.h : plugins/Makefile Makefile
 	@echo 'NULL' >> $@
 	@echo '};' >> $@
 
-# Git doesn't maintain timestamps, so we only regen if git says we should.
-# If neither is in git, we generate (note: one combines stderr, one discards)
-CHANGED_FROM_GIT = [ x"`git log $@ 2>&1 | head -n1`" != x"`git log $< 2>/dev/null | head -n1`" -o x"`git diff $<`" != x"" ]
-
 ifneq ($(TEST_GROUP_COUNT),)
 PYTEST_OPTS += --test-group=$(TEST_GROUP) --test-group-count=$(TEST_GROUP_COUNT)
 endif
@@ -452,7 +457,7 @@ $(CCAN_OBJS) $(CDUMP_OBJS): $(CCAN_HEADERS) Makefile
 $(ALL_OBJS): $(BITCOIN_HEADERS) $(COMMON_HEADERS) $(CCAN_HEADERS) $(WIRE_HEADERS) $(ALL_GEN_HEADERS) $(EXTERNAL_HEADERS) Makefile
 
 # We generate headers in two ways, so regen when either changes (or Makefile)
-$(ALL_GEN_HEADERS): ccan/ccan/cdump/tools/cdump-enumstr $(WIRE_GEN) Makefile
+$(ALL_GEN_HEADERS): ccan/ccan/cdump/tools/cdump-enumstr Makefile
 
 update-ccan:
 	mv ccan ccan.old

diff --git a/doc/Makefile b/doc/Makefile
@@ -58,7 +58,7 @@ MANPAGES := doc/lightning-cli.1 \
 doc-all: $(MANPAGES) doc/index.rst
 
 $(MANPAGES): doc/%: doc/%.md
-	@if $(CHANGED_FROM_GIT); then $(call VERBOSE, "mrkd $<", mrkd $< $@); else touch $@; fi
+	@if $(call SHA256STAMP_CHANGED,); then $(call VERBOSE, "mrkd $<", mrkd $< $@ && $(call SHA256STAMP,,\")); else touch $@; fi
 
 doc/protocol-%.svg: test/test_protocol
 	test/test_protocol --svg < test/commits/$*.script > $@

diff --git a/doc/lightning-autocleaninvoice.7 b/doc/lightning-autocleaninvoice.7
diff --git a/doc/lightning-check.7 b/doc/lightning-check.7
diff --git a/doc/lightning-checkmessage.7 b/doc/lightning-checkmessage.7
diff --git a/doc/lightning-cli.1 b/doc/lightning-cli.1
@@ -118,3 +118,4 @@ Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
 Note: the modules in the ccan/ directory have their own licenses, but
 the rest of the code is covered by the BSD-style MIT license\.
 
+\" SHA256STAMP:0269a00171f6ff2bbcb772b9367e05787345faf6457e75141978999fc0103d4a
diff --git a/doc/lightning-close.7 b/doc/lightning-close.7
diff --git a/doc/lightning-connect.7 b/doc/lightning-connect.7
diff --git a/doc/lightning-createonion.7 b/doc/lightning-createonion.7
diff --git a/doc/lightning-decodepay.7 b/doc/lightning-decodepay.7
diff --git a/doc/lightning-delexpiredinvoice.7 b/doc/lightning-delexpiredinvoice.7
diff --git a/doc/lightning-delinvoice.7 b/doc/lightning-delinvoice.7
diff --git a/doc/lightning-dev-sendcustommsg.7 b/doc/lightning-dev-sendcustommsg.7
diff --git a/doc/lightning-disconnect.7 b/doc/lightning-disconnect.7
diff --git a/doc/lightning-feerates.7 b/doc/lightning-feerates.7
diff --git a/doc/lightning-fundchannel.7 b/doc/lightning-fundchannel.7
diff --git a/doc/lightning-fundchannel_cancel.7 b/doc/lightning-fundchannel_cancel.7
diff --git a/doc/lightning-fundchannel_complete.7 b/doc/lightning-fundchannel_complete.7
diff --git a/doc/lightning-fundchannel_start.7 b/doc/lightning-fundchannel_start.7
diff --git a/doc/lightning-fundpsbt.7 b/doc/lightning-fundpsbt.7
diff --git a/doc/lightning-getroute.7 b/doc/lightning-getroute.7
diff --git a/doc/lightning-getsharedsecret.7 b/doc/lightning-getsharedsecret.7
diff --git a/doc/lightning-hsmtool.8 b/doc/lightning-hsmtool.8
@@ -76,3 +76,4 @@ Note: the modules in the ccan/ directory have their own licenses, but
 the rest of the code is covered by the BSD-style MIT license\.
 Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
 
+\" SHA256STAMP:11b3e6c050eb31e7faac10e8b75c3f7b7d57269f7f8c47c67f6d115b7a479c09
diff --git a/doc/lightning-invoice.7 b/doc/lightning-invoice.7
diff --git a/doc/lightning-keysend.7 b/doc/lightning-keysend.7
diff --git a/doc/lightning-listchannels.7 b/doc/lightning-listchannels.7
diff --git a/doc/lightning-listforwards.7 b/doc/lightning-listforwards.7
diff --git a/doc/lightning-listfunds.7 b/doc/lightning-listfunds.7
diff --git a/doc/lightning-listinvoices.7 b/doc/lightning-listinvoices.7
diff --git a/doc/lightning-listpays.7 b/doc/lightning-listpays.7
diff --git a/doc/lightning-listpeers.7 b/doc/lightning-listpeers.7
diff --git a/doc/lightning-listsendpays.7 b/doc/lightning-listsendpays.7
diff --git a/doc/lightning-newaddr.7 b/doc/lightning-newaddr.7
diff --git a/doc/lightning-pay.7 b/doc/lightning-pay.7
diff --git a/doc/lightning-plugin.7 b/doc/lightning-plugin.7
diff --git a/doc/lightning-reserveinputs.7 b/doc/lightning-reserveinputs.7
diff --git a/doc/lightning-sendonion.7 b/doc/lightning-sendonion.7
diff --git a/doc/lightning-sendpay.7 b/doc/lightning-sendpay.7
diff --git a/doc/lightning-setchannelfee.7 b/doc/lightning-setchannelfee.7
diff --git a/doc/lightning-signmessage.7 b/doc/lightning-signmessage.7
diff --git a/doc/lightning-txdiscard.7 b/doc/lightning-txdiscard.7
diff --git a/doc/lightning-txprepare.7 b/doc/lightning-txprepare.7
diff --git a/doc/lightning-txsend.7 b/doc/lightning-txsend.7
diff --git a/doc/lightning-unreserveinputs.7 b/doc/lightning-unreserveinputs.7
diff --git a/doc/lightning-utxopsbt.7 b/doc/lightning-utxopsbt.7
diff --git a/doc/lightning-waitanyinvoice.7 b/doc/lightning-waitanyinvoice.7
diff --git a/doc/lightning-waitblockheight.7 b/doc/lightning-waitblockheight.7
diff --git a/doc/lightning-waitinvoice.7 b/doc/lightning-waitinvoice.7
diff --git a/doc/lightning-waitsendpay.7 b/doc/lightning-waitsendpay.7
diff --git a/doc/lightning-withdraw.7 b/doc/lightning-withdraw.7
diff --git a/doc/lightningd-config.5 b/doc/lightningd-config.5
@@ -585,3 +585,4 @@ Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
 Note: the modules in the ccan/ directory have their own licenses, but
 the rest of the code is covered by the BSD-style MIT license\.
 
+\" SHA256STAMP:72bbbb26f1f4fbd25ef6021503be6266efa26bfbd0f146403ba04d7bca348358
diff --git a/doc/lightningd.8 b/doc/lightningd.8
@@ -257,3 +257,4 @@ Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
 Note: the modules in the ccan/ directory have their own licenses, but
 the rest of the code is covered by the BSD-style MIT license\.
 
+\" SHA256STAMP:2abc6ed205f21d695a2cc1f1953f3897ec4f1cb38e5aa3e594edb3393f9e50b9
Original file line number	Diff line number	Diff line change
Expand Up		@@ -118,3 +118,4 @@ Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
		Note: the modules in the ccan/ directory have their own licenses, but
		the rest of the code is covered by the BSD-style MIT license\.

		\" SHA256STAMP:0269a00171f6ff2bbcb772b9367e05787345faf6457e75141978999fc0103d4a
Original file line number	Diff line number	Diff line change
Expand Up		@@ -76,3 +76,4 @@ Note: the modules in the ccan/ directory have their own licenses, but
		the rest of the code is covered by the BSD-style MIT license\.
		Main web site: \fIhttps://github.com/ElementsProject/lightning\fR

		\" SHA256STAMP:11b3e6c050eb31e7faac10e8b75c3f7b7d57269f7f8c47c67f6d115b7a479c09
Original file line number	Diff line number	Diff line change
Expand Up		@@ -585,3 +585,4 @@ Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
		Note: the modules in the ccan/ directory have their own licenses, but
		the rest of the code is covered by the BSD-style MIT license\.

		\" SHA256STAMP:72bbbb26f1f4fbd25ef6021503be6266efa26bfbd0f146403ba04d7bca348358
Original file line number	Diff line number	Diff line change
Expand Up		@@ -257,3 +257,4 @@ Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
		Note: the modules in the ccan/ directory have their own licenses, but
		the rest of the code is covered by the BSD-style MIT license\.

		\" SHA256STAMP:2abc6ed205f21d695a2cc1f1953f3897ec4f1cb38e5aa3e594edb3393f9e50b9