[master] 4141e7a Halt rst2man/rst2html on warnings.

Lasse Karstensen lkarsten at varnish-software.com
Tue May 13 14:08:41 CEST 2014


commit 4141e7a47629ca2dfb6e1adbbc918a29767a7c9a
Author: Lasse Karstensen <lkarsten at varnish-software.com>
Date:   Tue May 13 13:21:49 2014 +0200

    Halt rst2man/rst2html on warnings.
    
    We don't allow compiler warnings in the C code, so I don't see any
    reason why we should allow warnings in the documentation.
    
    Warnings in the documentation are now build errors.

diff --git a/man/Makefile.am b/man/Makefile.am
index e4a0bfe..a3d3077 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -25,67 +25,69 @@ dist_man_MANS = \
 
 MAINTAINERCLEANFILES = $(dist_man_MANS)
 
+RST2ANY_FLAGS = --halt=2
+
 varnish-cli.7: $(top_srcdir)/doc/sphinx/reference/varnish-cli.rst
-	${RST2MAN} $(top_srcdir)/doc/sphinx/reference/varnish-cli.rst $@
+	${RST2MAN} $(RST2ANY_FLAGS) $(top_srcdir)/doc/sphinx/reference/varnish-cli.rst $@
 
 varnish-counters.7: vsc2rst
-	./vsc2rst | ${RST2MAN} - $@
+	./vsc2rst | ${RST2MAN} $(RST2ANY_FLAGS) - $@
 
 vcl.7: $(top_srcdir)/doc/sphinx/reference/vcl.rst \
 	$(top_srcdir)/bin/varnishd/builtin.vcl
-	${RST2MAN} $(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
-	${RST2MAN} $(top_srcdir)/doc/sphinx/reference/vsl.rst $@
+	${RST2MAN} $(RST2ANY_FLAGS) $(top_srcdir)/doc/sphinx/reference/vsl.rst $@
 
 vsl-query.7: $(top_srcdir)/doc/sphinx/reference/vsl-query.rst
-	${RST2MAN} $(top_srcdir)/doc/sphinx/reference/vsl-query.rst $@
+	${RST2MAN} $(RST2ANY_FLAGS) $(top_srcdir)/doc/sphinx/reference/vsl-query.rst $@
 
 varnishadm.1: $(top_srcdir)/doc/sphinx/reference/varnishadm.rst
-	${RST2MAN} $(top_srcdir)/doc/sphinx/reference/varnishadm.rst $@
+	${RST2MAN} $(RST2ANY_FLAGS) $(top_srcdir)/doc/sphinx/reference/varnishadm.rst $@
 
 varnishd.1: \
 	$(top_srcdir)/doc/sphinx/reference/varnishd.rst \
 	$(top_srcdir)/doc/sphinx/include/params.rst
-	${RST2MAN} $(top_srcdir)/doc/sphinx/reference/varnishd.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
-	${RST2MAN} $(top_srcdir)/doc/sphinx/reference/varnishncsa.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
-	${RST2MAN} $(top_srcdir)/doc/sphinx/reference/varnishlog.rst $@
+	${RST2MAN} $(RST2ANY_FLAGS) $(top_srcdir)/doc/sphinx/reference/varnishlog.rst $@
 
 varnishreplay.1: $(top_srcdir)/doc/sphinx/reference/varnishreplay.rst
-	${RST2MAN} $(top_srcdir)/doc/sphinx/reference/varnishreplay.rst $@
+	${RST2MAN} $(RST2ANY_FLAGS) $(top_srcdir)/doc/sphinx/reference/varnishreplay.rst $@
 
 # XXX add _options.rst and _synopsis.rst here when it's been _opt2rst'ed
 varnishstat.1: $(top_srcdir)/doc/sphinx/reference/varnishstat.rst
-	${RST2MAN} $(top_srcdir)/doc/sphinx/reference/varnishstat.rst $@
+	${RST2MAN} $(RST2ANY_FLAGS) $(top_srcdir)/doc/sphinx/reference/varnishstat.rst $@
 
 varnishtest.1: $(top_srcdir)/doc/sphinx/reference/varnishtest.rst
-	${RST2MAN} $(top_srcdir)/doc/sphinx/reference/varnishtest.rst $@
+	${RST2MAN} $(RST2ANY_FLAGS) $(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
-	${RST2MAN} $(top_srcdir)/doc/sphinx/reference/varnishtop.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
-	${RST2MAN} $(top_srcdir)/doc/sphinx/reference/varnishhist.rst $@
+	${RST2MAN} $(RST2ANY_FLAGS) $(top_srcdir)/doc/sphinx/reference/varnishhist.rst $@
 
 vmod_std.3: $(top_srcdir)/lib/libvmod_std/vmod_std.man.rst
-	${RST2MAN} $? $@
+	${RST2MAN} $(RST2ANY_FLAGS) $? $@
 
 vmod_directors.3: $(top_srcdir)/lib/libvmod_directors/vmod_directors.man.rst
-	${RST2MAN} $? $@
+	${RST2MAN} $(RST2ANY_FLAGS) $(RST2ANY_FLAGS) $? $@



More information about the varnish-commit mailing list