[ovs-dev] [PATCH] Documentation: Report errors for use of features not in Sphinx 1.1.3.
Ben Pfaff
blp at ovn.org
Tue Mar 7 18:54:34 UTC 2017
Signed-off-by: Ben Pfaff <blp at ovn.org>
---
Documentation/automake.mk | 15 ++++++++++++++-
Documentation/sphinx-version-blacklist | 2 ++
2 files changed, 16 insertions(+), 1 deletion(-)
create mode 100644 Documentation/sphinx-version-blacklist
diff --git a/Documentation/automake.mk b/Documentation/automake.mk
index a74807fde532..f7f1fe61d1b7 100644
--- a/Documentation/automake.mk
+++ b/Documentation/automake.mk
@@ -86,7 +86,8 @@ EXTRA_DIST += \
Documentation/internals/contributing/documentation-style.rst \
Documentation/internals/contributing/libopenvswitch-abi.rst \
Documentation/internals/contributing/submitting-patches.rst \
- Documentation/requirements.txt
+ Documentation/requirements.txt \
+ Documentation/sphinx-version-blacklist
# You can set these variables from the command line.
SPHINXOPTS =
@@ -120,3 +121,15 @@ endif
.PHONY: htmldocs
.PHONY: check-docs
.PHONY: clean-docs
+
+ALL_LOCAL += sphinx-version-check
+sphinx-version-check: $(EXTRA_DIST)
+ @if grep -n -f $(srcdir)/Documentation/sphinx-version-blacklist $?; \
+ then \
+ echo "See above for list of uses of features that Sphinx 1.1.3"; \
+ echo "does not support. Please avoid using these features.."; \
+ exit 1; \
+ else \
+ : > $@; \
+ fi
+CLEANFILES += sphinx-version-check
diff --git a/Documentation/sphinx-version-blacklist b/Documentation/sphinx-version-blacklist
new file mode 100644
index 000000000000..a67339bf2758
--- /dev/null
+++ b/Documentation/sphinx-version-blacklist
@@ -0,0 +1,2 @@
+code-block:: *ps1con
+code-block:: *doscon
--
2.10.2
More information about the dev
mailing list