[gnome-shell] docs: Use entity for version
- From: Florian Müllner <fmuellner src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-shell] docs: Use entity for version
- Date: Wed, 19 Jul 2017 22:56:00 +0000 (UTC)
commit 26e7962dfe4fe9b5b544da15d48d70ed2397b5b3
Author: Florian Müllner <fmuellner gnome org>
Date: Sun May 28 21:46:02 2017 +0200
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 +-
.../shell/{shell-docs.sgml.in => shell-docs.sgml} | 3 ++-
docs/reference/shell/version.xml.in | 1 +
docs/reference/st/Makefile.am | 2 +-
.../reference/st/{st-docs.sgml.in => st-docs.sgml} | 3 ++-
docs/reference/st/version.xml.in | 1 +
7 files changed, 10 insertions(+), 6 deletions(-)
---
diff --git a/configure.ac b/configure.ac
index 916d7c1..db30125 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 ad3a3de..715e3f2 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 14a9cf1..c349f84 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 0000000..d78bda9
--- /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 18e837d..df2d357 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 f5df261..788c204 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 0000000..d78bda9
--- /dev/null
+++ b/docs/reference/st/version.xml.in
@@ -0,0 +1 @@
+@VERSION@
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]