[master] dce6ecc Move all but vmods' rst generation to doc/sphinx

Federico G. Schwindt fgsch at lodoss.net
Wed May 4 18:57:05 CEST 2016


commit dce6eccdf3152288f8726193706e0440e15e70e9
Author: Federico G. Schwindt <fgsch at lodoss.net>
Date:   Wed May 4 10:59:28 2016 +0100

    Move all but vmods' rst generation to doc/sphinx
    
    Use builddir and other minor cleanups while here.

diff --git a/.gitignore b/.gitignore
index fb9cde6..fe1e27e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -69,7 +69,6 @@ cscope.*out
 /lib/libvarnishapi/vxp_fixed_token.c
 /lib/libvarnishapi/vxp_tokens.h
 /lib/libvarnishapi/vsl2rst
-/lib/libvarnishapi/vsl-tags.rst
 
 
 # Misc. generated files for included vmods.
diff --git a/doc/sphinx/Makefile.am b/doc/sphinx/Makefile.am
index e1a5588..14127df 100644
--- a/doc/sphinx/Makefile.am
+++ b/doc/sphinx/Makefile.am
@@ -123,7 +123,7 @@ distclean-local:
 	rm -rf $(BUILDDIR)
 
 include/params.rst: $(top_builddir)/bin/varnishd/varnishd
-	$(top_builddir)/bin/varnishd/varnishd -x dumprstparam > include/params.rst
+	$(top_builddir)/bin/varnishd/varnishd -x dumprstparam > $@
 BUILT_SOURCES = include/params.rst
 
 include/counters.rst: $(top_builddir)/bin/varnishstat/vsc2rst
@@ -160,6 +160,10 @@ include/varnishhist_synopsis.rst: $(top_builddir)/bin/varnishhist/varnishhist_op
 BUILT_SOURCES += include/varnishhist_options.rst \
 	 include/varnishhist_synopsis.rst
 
+include/vsl-tags.rst: $(top_builddir)/lib/libvarnishapi/vsl2rst
+	$(top_builddir)/lib/libvarnishapi/vsl2rst > $@
+BUILT_SOURCES += include/vsl-tags.rst
+
 .PHONY: reference
 reference:
 	test -d $@ || mkdir $@
diff --git a/doc/sphinx/reference/vsl.rst b/doc/sphinx/reference/vsl.rst
index 1aafd28..3f39c67 100644
--- a/doc/sphinx/reference/vsl.rst
+++ b/doc/sphinx/reference/vsl.rst
@@ -22,7 +22,7 @@ logging tools supplied with Varnish.
 VSL tags
 ~~~~~~~~
 
-.. include:: ../../../lib/libvarnishapi/vsl-tags.rst
+.. include:: ../include/vsl-tags.rst
 
 TIMESTAMPS
 ==========
diff --git a/lib/libvarnishapi/Makefile.am b/lib/libvarnishapi/Makefile.am
index 1bd045b..32986c4 100644
--- a/lib/libvarnishapi/Makefile.am
+++ b/lib/libvarnishapi/Makefile.am
@@ -16,7 +16,6 @@ libvarnishapi_la_SOURCES = \
 	vsl_api.h \
 	vxp.h \
 	vxp_tokens.h \
-	\
 	../libvarnish/vas.c \
 	../libvarnish/vav.c \
 	../../include/vcs_version.h \
@@ -57,21 +56,16 @@ libvarnishapi_la_LDFLAGS += -export-symbols-regex '^V'
 endif
 
 EXTRA_DIST = \
-	generate.py \
-	vsl-tags.rst
+	generate.py
 
 BUILT_SOURCES = \
 	vxp_fixed_token.c \
-	vxp_tokens.h \
-	vsl-tags.rst
+	vxp_tokens.h
 
 CLEANFILES = \
 	$(builddir)/vxp_fixed_token.c \
 	$(builddir)/vxp_tokens.h
 
-MAINTAINERCLEANFILES = \
-	vsl-tags.rst
-
 noinst_PROGRAMS = vsl2rst
 
 vsl2rst_SOURCES = \
@@ -79,9 +73,6 @@ vsl2rst_SOURCES = \
 	$(top_srcdir)/include/tbl/vsl_tags.h \
 	$(top_srcdir)/include/tbl/vsl_tags_http.h
 
-vsl-tags.rst: vsl2rst
-	./vsl2rst > $@
-
 vxp_fixed_token.c vxp_tokens.h: \
 	$(srcdir)/generate.py
 	@PYTHON@ $(srcdir)/generate.py $(srcdir) $(top_builddir)
@@ -105,5 +96,3 @@ vsl_glob_test_SOURCES = \
 vsl_glob_test_LDADD = @PCRE_LIBS@ ${RT_LIBS} ${LIBM} libvarnishapi.la
 
 vsl_glob_test_CFLAGS = -I$(top_srcdir)/include
-
-.NOPATH: $(BUILT_SOURCES)
diff --git a/man/Makefile.am b/man/Makefile.am
index 536d7a2..05a1618 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -32,7 +32,7 @@ vcl.7: $(top_srcdir)/doc/sphinx/reference/vcl.rst \
 	${RST2MAN} $(RST2ANY_FLAGS) $(top_srcdir)/doc/sphinx/reference/vcl.rst $@
 
 vsl.7: $(top_srcdir)/doc/sphinx/reference/vsl.rst \
-	$(top_srcdir)/lib/libvarnishapi/vsl-tags.rst
+	$(top_builddir)/doc/sphinx/include/vsl-tags.rst
 	${RST2MAN} $(RST2ANY_FLAGS) $(top_srcdir)/doc/sphinx/reference/vsl.rst $@
 
 vsl-query.7: $(top_srcdir)/doc/sphinx/reference/vsl-query.rst
@@ -43,19 +43,19 @@ varnishadm.1: $(top_srcdir)/doc/sphinx/reference/varnishadm.rst
 
 varnishd.1: \
 	$(top_srcdir)/doc/sphinx/reference/varnishd.rst \
-	$(top_srcdir)/doc/sphinx/include/params.rst
+	$(top_builddir)/doc/sphinx/include/params.rst
 	${RST2MAN} $(RST2ANY_FLAGS) $(top_srcdir)/doc/sphinx/reference/varnishd.rst $@
 
 varnishncsa.1: \
 	$(top_srcdir)/doc/sphinx/reference/varnishncsa.rst \
-	$(top_srcdir)/doc/sphinx/include/varnishncsa_options.rst \
-	$(top_srcdir)/doc/sphinx/include/varnishncsa_synopsis.rst
+	$(top_builddir)/doc/sphinx/include/varnishncsa_options.rst \
+	$(top_builddir)/doc/sphinx/include/varnishncsa_synopsis.rst
 	${RST2MAN} $(RST2ANY_FLAGS) $(top_srcdir)/doc/sphinx/reference/varnishncsa.rst $@
 
 varnishlog.1: \
 	$(top_srcdir)/doc/sphinx/reference/varnishlog.rst \
-	$(top_srcdir)/doc/sphinx/include/varnishlog_options.rst \
-	$(top_srcdir)/doc/sphinx/include/varnishlog_synopsis.rst
+	$(top_builddir)/doc/sphinx/include/varnishlog_options.rst \
+	$(top_builddir)/doc/sphinx/include/varnishlog_synopsis.rst
 	${RST2MAN} $(RST2ANY_FLAGS) $(top_srcdir)/doc/sphinx/reference/varnishlog.rst $@
 
 # XXX add _options.rst and _synopsis.rst here when it's been _opt2rst'ed
@@ -67,14 +67,14 @@ varnishtest.1: $(top_srcdir)/doc/sphinx/reference/varnishtest.rst
 
 varnishtop.1: \
 	$(top_srcdir)/doc/sphinx/reference/varnishtop.rst \
-	$(top_srcdir)/doc/sphinx/include/varnishtop_options.rst \
-	$(top_srcdir)/doc/sphinx/include/varnishtop_synopsis.rst
+	$(top_builddir)/doc/sphinx/include/varnishtop_options.rst \
+	$(top_builddir)/doc/sphinx/include/varnishtop_synopsis.rst
 	${RST2MAN} $(RST2ANY_FLAGS) $(top_srcdir)/doc/sphinx/reference/varnishtop.rst $@
 
 varnishhist.1: \
 	$(top_srcdir)/doc/sphinx/reference/varnishhist.rst \
-	$(top_srcdir)/doc/sphinx/include/varnishhist_options.rst \
-	$(top_srcdir)/doc/sphinx/include/varnishhist_synopsis.rst
+	$(top_builddir)/doc/sphinx/include/varnishhist_options.rst \
+	$(top_builddir)/doc/sphinx/include/varnishhist_synopsis.rst
 	${RST2MAN} $(RST2ANY_FLAGS) $(top_srcdir)/doc/sphinx/reference/varnishhist.rst $@
 
 vmod_std.3: $(top_builddir)/lib/libvmod_std/vmod_std.man.rst



More information about the varnish-commit mailing list