[pve-devel] [PATCH docs 2/2] buildsys: allow re-building synopsis & opts files standalone

Thomas Lamprecht t.lamprecht at proxmox.com
Wed Oct 18 10:12:46 CEST 2017


Add two new make targets 'update-static', 'clean-static' which split
out functionality from the 'update' target.
As the latter uses the long duration `make all` anybody which just
wants to see the current synopsis (e.g., when improving a chapter)
spends a lot time waiting here.

The new target clean or update (generate) specifically just the
synopsis, opts, apidata and firewall macro files from the current
installed package versions, allowing faster build times when one does
frequent edit-build cycles.
---
 Makefile | 16 +++++++++++-----
 1 file changed, 11 insertions(+), 5 deletions(-)

diff --git a/Makefile b/Makefile
index f27f3ec..61d8fbc 100644
--- a/Makefile
+++ b/Makefile
@@ -220,16 +220,22 @@ upload: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
 	tar cf - ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} | ssh -X repoman at repo.proxmox.com -- upload --product pve --dist stretch
 
 .PHONY: update
-update: clean
+update: clean clean-static | update-static
+	make all
+
+.PHONY: update-static
+update-static: clean-static | $(filter %-synopsis.adoc %-opts.adoc, ${PVE_ADMIN_GUIDE_ADOCDEPENDS}) pve-firewall-macros.adoc api-viewer/apidata.js
+
+.PHONY: clean-static
+clean-static:
 	find . -regex '.*-\(opts\|synopsis\)\.adoc' -not -name pmxcfs.8-synopsis.adoc -exec rm -f \{\} \;
 	rm -f api-viewer/apidata.js
 	rm -f pve-firewall-macros.adoc pct-network-opts.adoc pct-mountpoint-opts.adoc
-	make all
 
-clean: 
+clean:
 	rm -rf *.html *.pdf *.epub *.tmp *.1 *.5 *.8
 	rm -f *.deb *.changes *.buildinfo
-	rm -f api-viewer/apidoc.js chapter-*.html *-plain.html chapter-*.html pve-admin-guide.chunked asciidoc-pve link-refs.json .asciidoc-pve-tmp_* pve-docs-mediawiki-import 
-	rm -rf .pve-doc-depends 
+	rm -f api-viewer/apidoc.js chapter-*.html *-plain.html chapter-*.html pve-admin-guide.chunked asciidoc-pve link-refs.json .asciidoc-pve-tmp_* pve-docs-mediawiki-import
+	rm -rf .pve-doc-depends
 	rm -f pve-doc-generator.mk chapter-index-table.adoc man1-index-table.adoc man5-index-table.adoc man8-index-table.adoc pve-admin-guide-docinfo.xml
 	rm -rf build-*
-- 
2.11.0




More information about the pve-devel mailing list