colin/NetworkManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

man: include version from a XML entity

Browse Source 
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.
This commit is contained in:
Lubomir Rintel
2016-04-04 19:22:45 +02:00
parent 8035b5b03b
commit 60582bf443
12 changed files with 54 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@@ -220,6 +220,7 @@ test-*.trs
/man/nm-settings.xml /man/nm-settings.xml
/man/nm-settings-ifcfg-rh.xml /man/nm-settings-ifcfg-rh.xml
/man/nm-settings-keyfile.xml /man/nm-settings-keyfile.xml
/man/common.ent
/po/*.gmo /po/*.gmo
/po/.intltool-merge-cache /po/.intltool-merge-cache

1
configure.ac
View File

@@ -1077,6 +1077,7 @@ clients/tui/newt/Makefile
introspection/Makefile introspection/Makefile
introspection/all.xml introspection/all.xml
man/Makefile man/Makefile
man/common.ent
po/Makefile.in po/Makefile.in
policy/Makefile policy/Makefile
policy/org.freedesktop.NetworkManager.policy.in policy/org.freedesktop.NetworkManager.policy.in

21
man/Makefile.am
View File

@@ -17,13 +17,13 @@ XSLTPROC_MAN_FLAGS = \
if ENABLE_GTK_DOC if ENABLE_GTK_DOC
%.1: %.xml %.1: %.xml common.ent
$(AM_V_GEN) xsltproc $(XSLTPROC_MAN_FLAGS) $< $(AM_V_GEN) xsltproc $(XSLTPROC_MAN_FLAGS) $<
%.5: %.xml %.5: %.xml common.ent
$(AM_V_GEN) xsltproc $(XSLTPROC_MAN_FLAGS) $< $(AM_V_GEN) xsltproc $(XSLTPROC_MAN_FLAGS) $<
%.8: %.xml %.8: %.xml common.ent
$(AM_V_GEN) xsltproc $(XSLTPROC_MAN_FLAGS) $< $(AM_V_GEN) xsltproc $(XSLTPROC_MAN_FLAGS) $<
endif endif
@@ -41,22 +41,13 @@ NetworkManager.conf.xml: $(srcdir)/NetworkManager.conf.xml.in
if BUILD_SETTING_DOCS if BUILD_SETTING_DOCS
nm-settings.xml: nm-settings.xsl $(top_builddir)/libnm/nm-setting-docs.xml nm-settings.xml: nm-settings.xsl $(top_builddir)/libnm/nm-setting-docs.xml
$(AM_V_GEN) xsltproc \ $(AM_V_GEN) xsltproc --output $@ $^
--output $@ \
--stringparam version $(NM_VERSION) \
$^
nm-settings-keyfile.xml: nm-settings-keyfile.xsl $(top_builddir)/libnm/nm-keyfile-docs.xml nm-settings-keyfile.xml: nm-settings-keyfile.xsl $(top_builddir)/libnm/nm-keyfile-docs.xml
$(AM_V_GEN) xsltproc \ $(AM_V_GEN) xsltproc --output $@ $^
--output $@ \
--stringparam version $(NM_VERSION) \
$^
nm-settings-ifcfg-rh.xml: nm-settings-ifcfg-rh.xsl $(top_builddir)/libnm/nm-ifcfg-rh-docs.xml nm-settings-ifcfg-rh.xml: nm-settings-ifcfg-rh.xsl $(top_builddir)/libnm/nm-ifcfg-rh-docs.xml
$(AM_V_GEN) xsltproc \ $(AM_V_GEN) xsltproc --output $@ $^
--output $@ \
--stringparam version $(NM_VERSION) \
$^
CLEANFILES += \ CLEANFILES += \
nm-settings.xml \ nm-settings.xml \

9
man/NetworkManager.xml
View File

@@ -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"?> <?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" <!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. Copyright 2005 - 2014 Red Hat, Inc.
@@ -19,7 +22,7 @@
<manvolnum>8</manvolnum> <manvolnum>8</manvolnum>
<refmiscinfo class="source">NetworkManager</refmiscinfo> <refmiscinfo class="source">NetworkManager</refmiscinfo>
<refmiscinfo class="manual">Network management daemons</refmiscinfo> <refmiscinfo class="manual">Network management daemons</refmiscinfo>
<refmiscinfo class="version">1.2</refmiscinfo> <refmiscinfo class="version">&NM_VERSION;</refmiscinfo>
</refmeta> </refmeta>
<refnamediv> <refnamediv>

2
man/common.ent.in Normal file
View File

@@ -0,0 +1,2 @@
<?xml version="1.0" encoding="utf-8" ?>
<!ENTITY NM_VERSION "@NM_VERSION@">

7
man/nm-online.xml
View File

@@ -1,7 +1,10 @@
<?xml version='1.0'?> <?xml version='1.0'?>
<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?> <?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" <!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 nm-online(1) manual page
@@ -40,7 +43,7 @@
<manvolnum>1</manvolnum> <manvolnum>1</manvolnum>
<refmiscinfo class="source">NetworkManager</refmiscinfo> <refmiscinfo class="source">NetworkManager</refmiscinfo>
<refmiscinfo class="manual">General Commands Manual</refmiscinfo> <refmiscinfo class="manual">General Commands Manual</refmiscinfo>
<refmiscinfo class="version">1.2</refmiscinfo> <refmiscinfo class="version">&NM_VERSION;</refmiscinfo>
</refmeta> </refmeta>
<refnamediv> <refnamediv>

8
man/nm-settings-ifcfg-rh.xsl
View File

@@ -1,4 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE stylesheet [
<!ENTITY % entities SYSTEM "common.ent" >
%entities;
]>
<xsl:stylesheet version="1.0" <xsl:stylesheet version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> 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" 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: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'"/> <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"> <refentry id="nm-settings-ifcfg-rh">
@@ -22,7 +24,7 @@
<manvolnum>5</manvolnum> <manvolnum>5</manvolnum>
<refmiscinfo class="source">NetworkManager</refmiscinfo> <refmiscinfo class="source">NetworkManager</refmiscinfo>
<refmiscinfo class="manual">Configuration</refmiscinfo> <refmiscinfo class="manual">Configuration</refmiscinfo>
<refmiscinfo class="version"><xsl:value-of select="$version"/></refmiscinfo> <refmiscinfo class="version">&NM_VERSION;</refmiscinfo>
</refmeta> </refmeta>
<refnamediv> <refnamediv>
<refname>nm-settings-ifcfg-rh</refname> <refname>nm-settings-ifcfg-rh</refname>

8
man/nm-settings-keyfile.xsl
View File

@@ -1,4 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE stylesheet [
<!ENTITY % entities SYSTEM "common.ent" >
%entities;
]>
<xsl:stylesheet version="1.0" <xsl:stylesheet version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> 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" doctype-system="http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
/> />
<xsl:param name="version"/>
<xsl:template match="nm-keyfile-docs"> <xsl:template match="nm-keyfile-docs">
<refentry id="nm-settings-keyfile"> <refentry id="nm-settings-keyfile">
<refmeta> <refmeta>
@@ -17,7 +19,7 @@
<manvolnum>5</manvolnum> <manvolnum>5</manvolnum>
<refmiscinfo class="source">NetworkManager</refmiscinfo> <refmiscinfo class="source">NetworkManager</refmiscinfo>
<refmiscinfo class="manual">Configuration</refmiscinfo> <refmiscinfo class="manual">Configuration</refmiscinfo>
<refmiscinfo class="version"><xsl:value-of select="$version"/></refmiscinfo> <refmiscinfo class="version">&NM_VERSION;</refmiscinfo>
</refmeta> </refmeta>
<refnamediv> <refnamediv>
<refname>nm-settings-keyfile</refname> <refname>nm-settings-keyfile</refname>

8
man/nm-settings.xsl
View File

@@ -1,4 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE stylesheet [
<!ENTITY % entities SYSTEM "common.ent" >
%entities;
]>
<xsl:stylesheet version="1.0" <xsl:stylesheet version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> 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" doctype-system="http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
/> />
<xsl:param name="version"/>
<xsl:template match="nm-setting-docs"> <xsl:template match="nm-setting-docs">
<refentry id="nm-settings"> <refentry id="nm-settings">
<refmeta> <refmeta>
@@ -17,7 +19,7 @@
<manvolnum>5</manvolnum> <manvolnum>5</manvolnum>
<refmiscinfo class="source">NetworkManager</refmiscinfo> <refmiscinfo class="source">NetworkManager</refmiscinfo>
<refmiscinfo class="manual">Configuration</refmiscinfo> <refmiscinfo class="manual">Configuration</refmiscinfo>
<refmiscinfo class="version"><xsl:value-of select="$version"/></refmiscinfo> <refmiscinfo class="version">&NM_VERSION;</refmiscinfo>
</refmeta> </refmeta>
<refnamediv> <refnamediv>
<refname>nm-settings</refname> <refname>nm-settings</refname>

12
man/nmcli-examples.xml
View File

@@ -1,6 +1,10 @@
<?xml version='1.0'?> <!--*-nxml-*--> <?xml version='1.0'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" <?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> <!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. Copyright 2013 - 2014 Red Hat, Inc.
@@ -17,7 +21,7 @@ Copyright 2013 - 2014 Red Hat, Inc.
<manvolnum>5</manvolnum> <manvolnum>5</manvolnum>
<refmiscinfo class="source">NetworkManager</refmiscinfo> <refmiscinfo class="source">NetworkManager</refmiscinfo>
<refmiscinfo class="manual">Examples</refmiscinfo> <refmiscinfo class="manual">Examples</refmiscinfo>
<refmiscinfo class="version">1.2</refmiscinfo> <refmiscinfo class="version">&NM_VERSION;</refmiscinfo>
</refmeta> </refmeta>
<refnamediv> <refnamediv>

7
man/nmcli.xml
View File

@@ -1,7 +1,10 @@
<?xml version='1.0'?> <?xml version='1.0'?>
<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?> <?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" <!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 nmcli(1) manual page
@@ -40,7 +43,7 @@
<manvolnum>1</manvolnum> <manvolnum>1</manvolnum>
<refmiscinfo class="source">NetworkManager</refmiscinfo> <refmiscinfo class="source">NetworkManager</refmiscinfo>
<refmiscinfo class="manual">General Commands Manual</refmiscinfo> <refmiscinfo class="manual">General Commands Manual</refmiscinfo>
<refmiscinfo class="version">1.2</refmiscinfo> <refmiscinfo class="version">&NM_VERSION;</refmiscinfo>
</refmeta> </refmeta>
<refnamediv> <refnamediv>

7
man/nmtui.xml
View File

@@ -1,7 +1,10 @@
<?xml version='1.0'?> <?xml version='1.0'?>
<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?> <?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" <!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 nmtui(1) manual page
@@ -40,7 +43,7 @@
<manvolnum>1</manvolnum> <manvolnum>1</manvolnum>
<refmiscinfo class="source">NetworkManager</refmiscinfo> <refmiscinfo class="source">NetworkManager</refmiscinfo>
<refmiscinfo class="manual">General Commands Manual</refmiscinfo> <refmiscinfo class="manual">General Commands Manual</refmiscinfo>
<refmiscinfo class="version">1.2</refmiscinfo> <refmiscinfo class="version">&NM_VERSION;</refmiscinfo>
</refmeta> </refmeta>
<refnamediv> <refnamediv>