summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLubomir Rintel <lkundrak@v3.sk>2016-04-04 19:22:45 +0200
committerLubomir Rintel <lkundrak@v3.sk>2016-04-05 14:37:51 +0200
commit60582bf44372eda37676e9e8209fbb5591851e4c (patch)
treee4731f5d64c0f3db017f16441b83c94c780a8db7
parent8035b5b03bb25d7b458d4e05b83239d7cfa4fcc7 (diff)
downloadNetworkManager-60582bf44372eda37676e9e8209fbb5591851e4c.tar.gz
man: include version from a XML entity
This way it's consistently used across all manual page without a need for XSL templating. Also, the entities file could in future possibly be used to template the build-time configurables such as filesystem paths or bug tracker URL.
-rw-r--r--.gitignore1
-rw-r--r--configure.ac1
-rw-r--r--man/Makefile.am21
-rw-r--r--man/NetworkManager.xml9
-rw-r--r--man/common.ent.in2
-rw-r--r--man/nm-online.xml7
-rw-r--r--man/nm-settings-ifcfg-rh.xsl8
-rw-r--r--man/nm-settings-keyfile.xsl8
-rw-r--r--man/nm-settings.xsl8
-rw-r--r--man/nmcli-examples.xml12
-rw-r--r--man/nmcli.xml7
-rw-r--r--man/nmtui.xml7
12 files changed, 54 insertions, 37 deletions
diff --git a/.gitignore b/.gitignore
index fbf35bd361..78a9130a24 100644
--- a/.gitignore
+++ b/.gitignore
@@ -220,6 +220,7 @@ test-*.trs
/man/nm-settings.xml
/man/nm-settings-ifcfg-rh.xml
/man/nm-settings-keyfile.xml
+/man/common.ent
/po/*.gmo
/po/.intltool-merge-cache
diff --git a/configure.ac b/configure.ac
index 6111da89f6..412061c78b 100644
--- a/configure.ac
+++ b/configure.ac
@@ -1077,6 +1077,7 @@ clients/tui/newt/Makefile
introspection/Makefile
introspection/all.xml
man/Makefile
+man/common.ent
po/Makefile.in
policy/Makefile
policy/org.freedesktop.NetworkManager.policy.in
diff --git a/man/Makefile.am b/man/Makefile.am
index 5b9cf1c0d5..9ab8b5f12f 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -17,13 +17,13 @@ XSLTPROC_MAN_FLAGS = \
if ENABLE_GTK_DOC
-%.1: %.xml
+%.1: %.xml common.ent
$(AM_V_GEN) xsltproc $(XSLTPROC_MAN_FLAGS) $<
-%.5: %.xml
+%.5: %.xml common.ent
$(AM_V_GEN) xsltproc $(XSLTPROC_MAN_FLAGS) $<
-%.8: %.xml
+%.8: %.xml common.ent
$(AM_V_GEN) xsltproc $(XSLTPROC_MAN_FLAGS) $<
endif
@@ -41,22 +41,13 @@ NetworkManager.conf.xml: $(srcdir)/NetworkManager.conf.xml.in
if BUILD_SETTING_DOCS
nm-settings.xml: nm-settings.xsl $(top_builddir)/libnm/nm-setting-docs.xml
- $(AM_V_GEN) xsltproc \
- --output $@ \
- --stringparam version $(NM_VERSION) \
- $^
+ $(AM_V_GEN) xsltproc --output $@ $^
nm-settings-keyfile.xml: nm-settings-keyfile.xsl $(top_builddir)/libnm/nm-keyfile-docs.xml
- $(AM_V_GEN) xsltproc \
- --output $@ \
- --stringparam version $(NM_VERSION) \
- $^
+ $(AM_V_GEN) xsltproc --output $@ $^
nm-settings-ifcfg-rh.xml: nm-settings-ifcfg-rh.xsl $(top_builddir)/libnm/nm-ifcfg-rh-docs.xml
- $(AM_V_GEN) xsltproc \
- --output $@ \
- --stringparam version $(NM_VERSION) \
- $^
+ $(AM_V_GEN) xsltproc --output $@ $^
CLEANFILES += \
nm-settings.xml \
diff --git a/man/NetworkManager.xml b/man/NetworkManager.xml
index 39dfe484ba..9bf71e8824 100644
--- a/man/NetworkManager.xml
+++ b/man/NetworkManager.xml
@@ -1,7 +1,10 @@
-<?xml version='1.0'?> <!--*-nxml-*-->
+<?xml version='1.0'?>
<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+<!ENTITY % entities SYSTEM "common.ent" >
+%entities;
+]>
<!--
Copyright 2005 - 2014 Red Hat, Inc.
@@ -19,7 +22,7 @@
<manvolnum>8</manvolnum>
<refmiscinfo class="source">NetworkManager</refmiscinfo>
<refmiscinfo class="manual">Network management daemons</refmiscinfo>
- <refmiscinfo class="version">1.2</refmiscinfo>
+ <refmiscinfo class="version">&NM_VERSION;</refmiscinfo>
</refmeta>
<refnamediv>
diff --git a/man/common.ent.in b/man/common.ent.in
new file mode 100644
index 0000000000..cd43b8d8e9
--- /dev/null
+++ b/man/common.ent.in
@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!ENTITY NM_VERSION "@NM_VERSION@">
diff --git a/man/nm-online.xml b/man/nm-online.xml
index ff7815618d..f1f7a0d4b8 100644
--- a/man/nm-online.xml
+++ b/man/nm-online.xml
@@ -1,7 +1,10 @@
<?xml version='1.0'?>
<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+<!ENTITY % entities SYSTEM "common.ent" >
+%entities;
+]>
<!--
nm-online(1) manual page
@@ -40,7 +43,7 @@
<manvolnum>1</manvolnum>
<refmiscinfo class="source">NetworkManager</refmiscinfo>
<refmiscinfo class="manual">General Commands Manual</refmiscinfo>
- <refmiscinfo class="version">1.2</refmiscinfo>
+ <refmiscinfo class="version">&NM_VERSION;</refmiscinfo>
</refmeta>
<refnamediv>
diff --git a/man/nm-settings-ifcfg-rh.xsl b/man/nm-settings-ifcfg-rh.xsl
index 08508d06eb..ecd1e3cebc 100644
--- a/man/nm-settings-ifcfg-rh.xsl
+++ b/man/nm-settings-ifcfg-rh.xsl
@@ -1,4 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE stylesheet [
+<!ENTITY % entities SYSTEM "common.ent" >
+%entities;
+]>
<xsl:stylesheet version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
@@ -12,8 +16,6 @@
doctype-system="http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
/>
- <xsl:param name="version"/>
-
<xsl:template match="nm-ifcfg-rh-docs">
<xsl:variable name="unsupported" select="'adsl, bluetooth, ppp, pppoe, serial, generic, gsm, cdma, 802-11-olpc-mesh, wimax, vpn'"/>
<refentry id="nm-settings-ifcfg-rh">
@@ -22,7 +24,7 @@
<manvolnum>5</manvolnum>
<refmiscinfo class="source">NetworkManager</refmiscinfo>
<refmiscinfo class="manual">Configuration</refmiscinfo>
- <refmiscinfo class="version"><xsl:value-of select="$version"/></refmiscinfo>
+ <refmiscinfo class="version">&NM_VERSION;</refmiscinfo>
</refmeta>
<refnamediv>
<refname>nm-settings-ifcfg-rh</refname>
diff --git a/man/nm-settings-keyfile.xsl b/man/nm-settings-keyfile.xsl
index 3e83490baa..e4751b1567 100644
--- a/man/nm-settings-keyfile.xsl
+++ b/man/nm-settings-keyfile.xsl
@@ -1,4 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE stylesheet [
+<!ENTITY % entities SYSTEM "common.ent" >
+%entities;
+]>
<xsl:stylesheet version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
@@ -8,8 +12,6 @@
doctype-system="http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
/>
- <xsl:param name="version"/>
-
<xsl:template match="nm-keyfile-docs">
<refentry id="nm-settings-keyfile">
<refmeta>
@@ -17,7 +19,7 @@
<manvolnum>5</manvolnum>
<refmiscinfo class="source">NetworkManager</refmiscinfo>
<refmiscinfo class="manual">Configuration</refmiscinfo>
- <refmiscinfo class="version"><xsl:value-of select="$version"/></refmiscinfo>
+ <refmiscinfo class="version">&NM_VERSION;</refmiscinfo>
</refmeta>
<refnamediv>
<refname>nm-settings-keyfile</refname>
diff --git a/man/nm-settings.xsl b/man/nm-settings.xsl
index e29a9f6464..490f1374ee 100644
--- a/man/nm-settings.xsl
+++ b/man/nm-settings.xsl
@@ -1,4 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE stylesheet [
+<!ENTITY % entities SYSTEM "common.ent" >
+%entities;
+]>
<xsl:stylesheet version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
@@ -8,8 +12,6 @@
doctype-system="http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
/>
- <xsl:param name="version"/>
-
<xsl:template match="nm-setting-docs">
<refentry id="nm-settings">
<refmeta>
@@ -17,7 +19,7 @@
<manvolnum>5</manvolnum>
<refmiscinfo class="source">NetworkManager</refmiscinfo>
<refmiscinfo class="manual">Configuration</refmiscinfo>
- <refmiscinfo class="version"><xsl:value-of select="$version"/></refmiscinfo>
+ <refmiscinfo class="version">&NM_VERSION;</refmiscinfo>
</refmeta>
<refnamediv>
<refname>nm-settings</refname>
diff --git a/man/nmcli-examples.xml b/man/nmcli-examples.xml
index 84eb2b0eb0..94a13c8dde 100644
--- a/man/nmcli-examples.xml
+++ b/man/nmcli-examples.xml
@@ -1,6 +1,10 @@
-<?xml version='1.0'?> <!--*-nxml-*-->
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
-"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
+<?xml version='1.0'?>
+<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+<!ENTITY % entities SYSTEM "common.ent" >
+%entities;
+]>
<!--
Copyright 2013 - 2014 Red Hat, Inc.
@@ -17,7 +21,7 @@ Copyright 2013 - 2014 Red Hat, Inc.
<manvolnum>5</manvolnum>
<refmiscinfo class="source">NetworkManager</refmiscinfo>
<refmiscinfo class="manual">Examples</refmiscinfo>
- <refmiscinfo class="version">1.2</refmiscinfo>
+ <refmiscinfo class="version">&NM_VERSION;</refmiscinfo>
</refmeta>
<refnamediv>
diff --git a/man/nmcli.xml b/man/nmcli.xml
index 21faf1af46..324e045ece 100644
--- a/man/nmcli.xml
+++ b/man/nmcli.xml
@@ -1,7 +1,10 @@
<?xml version='1.0'?>
<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+<!ENTITY % entities SYSTEM "common.ent" >
+%entities;
+]>
<!--
nmcli(1) manual page
@@ -40,7 +43,7 @@
<manvolnum>1</manvolnum>
<refmiscinfo class="source">NetworkManager</refmiscinfo>
<refmiscinfo class="manual">General Commands Manual</refmiscinfo>
- <refmiscinfo class="version">1.2</refmiscinfo>
+ <refmiscinfo class="version">&NM_VERSION;</refmiscinfo>
</refmeta>
<refnamediv>
diff --git a/man/nmtui.xml b/man/nmtui.xml
index e203c7d04f..d92f525bca 100644
--- a/man/nmtui.xml
+++ b/man/nmtui.xml
@@ -1,7 +1,10 @@
<?xml version='1.0'?>
<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+<!ENTITY % entities SYSTEM "common.ent" >
+%entities;
+]>
<!--
nmtui(1) manual page
@@ -40,7 +43,7 @@
<manvolnum>1</manvolnum>
<refmiscinfo class="source">NetworkManager</refmiscinfo>
<refmiscinfo class="manual">General Commands Manual</refmiscinfo>
- <refmiscinfo class="version">1.2</refmiscinfo>
+ <refmiscinfo class="version">&NM_VERSION;</refmiscinfo>
</refmeta>
<refnamediv>