mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager
synced 2024-10-06 16:21:50 +00:00
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.
This commit is contained in:
parent
8035b5b03b
commit
60582bf443
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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 \
|
||||
|
|
|
@ -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>
|
||||
|
|
2
man/common.ent.in
Normal file
2
man/common.ent.in
Normal file
|
@ -0,0 +1,2 @@
|
|||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<!ENTITY NM_VERSION "@NM_VERSION@">
|
|
@ -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>
|
||||
|
|
|
@ -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>
|
||||
|
|
|
@ -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>
|
||||
|
|
|
@ -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>
|
||||
|
|
|
@ -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>
|
||||
|
|
|
@ -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>
|
||||
|
|
|
@ -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>
|
||||
|
|
Loading…
Reference in a new issue