From 26e7962dfe4fe9b5b544da15d48d70ed2397b5b3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Florian=20M=C3=BCllner?= <fmuellner@gnome.org>
Date: Sun, 28 May 2017 21:46:02 +0200
Subject: [PATCH] docs: Use entity for version

Meson's gtk-doc support currently requires the main SGML/XML file
to be located in the srcdir, so instead of substituting the module
version in that file directly, use a small auxiliary file that's
included via a custom entity.

https://bugzilla.gnome.org/show_bug.cgi?id=783229
---
 configure.ac                                                 | 4 ++--
 docs/reference/shell/Makefile.am                             | 2 +-
 docs/reference/shell/{shell-docs.sgml.in => shell-docs.sgml} | 3 ++-
 docs/reference/shell/version.xml.in                          | 1 +
 docs/reference/st/Makefile.am                                | 2 +-
 docs/reference/st/{st-docs.sgml.in => st-docs.sgml}          | 3 ++-
 docs/reference/st/version.xml.in                             | 1 +
 7 files changed, 10 insertions(+), 6 deletions(-)
 rename docs/reference/shell/{shell-docs.sgml.in => shell-docs.sgml} (97%)
 create mode 100644 docs/reference/shell/version.xml.in
 rename docs/reference/st/{st-docs.sgml.in => st-docs.sgml} (97%)
 create mode 100644 docs/reference/st/version.xml.in

diff --git a/configure.ac b/configure.ac
index 916d7c108..db30125df 100644
--- a/configure.ac
+++ b/configure.ac
@@ -254,9 +254,9 @@ AC_CONFIG_FILES([
   docs/Makefile
   docs/reference/Makefile
   docs/reference/shell/Makefile
-  docs/reference/shell/shell-docs.sgml
+  docs/reference/shell/version.xml
   docs/reference/st/Makefile
-  docs/reference/st/st-docs.sgml
+  docs/reference/st/version.xml
   js/Makefile
   src/Makefile
   subprojects/gvc/Makefile
diff --git a/docs/reference/shell/Makefile.am b/docs/reference/shell/Makefile.am
index ad3a3defe..715e3f26c 100644
--- a/docs/reference/shell/Makefile.am
+++ b/docs/reference/shell/Makefile.am
@@ -120,7 +120,7 @@ include $(top_srcdir)/gtk-doc.make
 
 # Other files to distribute
 # e.g. EXTRA_DIST += version.xml.in
-EXTRA_DIST +=
+EXTRA_DIST += version.xml.in
 
 # Files not to distribute
 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
diff --git a/docs/reference/shell/shell-docs.sgml.in b/docs/reference/shell/shell-docs.sgml
similarity index 97%
rename from docs/reference/shell/shell-docs.sgml.in
rename to docs/reference/shell/shell-docs.sgml
index 14a9cf1cd..c349f84a5 100644
--- a/docs/reference/shell/shell-docs.sgml.in
+++ b/docs/reference/shell/shell-docs.sgml
@@ -3,12 +3,13 @@
                "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
 [
   <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+  <!ENTITY version SYSTEM "version.xml">
 ]>
 <book id="index">
   <bookinfo>
     <title>Shell Reference Manual</title>
     <releaseinfo>
-      for Shell @VERSION@.
+      for Shell &version;.
       <!--The latest version of this documentation can be found on-line at
       <ulink role="online-location" url="http://[SERVER]/shell/index.html">http://[SERVER]/shell/</ulink>.-->
     </releaseinfo>
diff --git a/docs/reference/shell/version.xml.in b/docs/reference/shell/version.xml.in
new file mode 100644
index 000000000..d78bda934
--- /dev/null
+++ b/docs/reference/shell/version.xml.in
@@ -0,0 +1 @@
+@VERSION@
diff --git a/docs/reference/st/Makefile.am b/docs/reference/st/Makefile.am
index 18e837d24..df2d357d5 100644
--- a/docs/reference/st/Makefile.am
+++ b/docs/reference/st/Makefile.am
@@ -85,7 +85,7 @@ include $(top_srcdir)/gtk-doc.make
 
 # Other files to distribute
 # e.g. EXTRA_DIST += version.xml.in
-EXTRA_DIST +=
+EXTRA_DIST += version.xml.in
 
 # Files not to distribute
 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
diff --git a/docs/reference/st/st-docs.sgml.in b/docs/reference/st/st-docs.sgml
similarity index 97%
rename from docs/reference/st/st-docs.sgml.in
rename to docs/reference/st/st-docs.sgml
index f5df261d7..788c20460 100644
--- a/docs/reference/st/st-docs.sgml.in
+++ b/docs/reference/st/st-docs.sgml
@@ -3,12 +3,13 @@
                "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
 [
   <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+  <!ENTITY version SYSTEM "version.xml">
 ]>
 <book id="index">
   <bookinfo>
     <title>St Reference Manual</title>
     <releaseinfo>
-      for St @VERSION@.
+      for St &version;.
       <!--The latest version of this documentation can be found on-line at
       <ulink role="online-location" url="http://[SERVER]/st/index.html">http://[SERVER]/st/</ulink>.-->
     </releaseinfo>
diff --git a/docs/reference/st/version.xml.in b/docs/reference/st/version.xml.in
new file mode 100644
index 000000000..d78bda934
--- /dev/null
+++ b/docs/reference/st/version.xml.in
@@ -0,0 +1 @@
+@VERSION@