Blame SOURCES/0001-doc-extend-description-of-config-handling.patch

6b8fee
From 98a69ca00e3441128b181b59c06bb06e8c362360 Mon Sep 17 00:00:00 2001
6b8fee
From: Sumit Bose <sbose@redhat.com>
6b8fee
Date: Fri, 29 Nov 2019 21:57:02 +0100
6b8fee
Subject: [PATCH] doc: extend description of config handling
6b8fee
6b8fee
Related to https://bugzilla.redhat.com/show_bug.cgi?id=1625005
6b8fee
---
6b8fee
 doc/manual/Makefile.am     |  8 ++++++++
6b8fee
 doc/manual/realmd.conf.xml | 15 +++++++++++----
6b8fee
 doc/privatedir.xml.in      |  1 +
6b8fee
 4 files changed, 21 insertions(+), 4 deletions(-)
6b8fee
 create mode 100644 doc/privatedir.xml.in
6b8fee
6b8fee
diff --git a/doc/manual/Makefile.am b/doc/manual/Makefile.am
6b8fee
index 8b33fdd..9812c45 100644
6b8fee
--- a/doc/manual/Makefile.am
6b8fee
+++ b/doc/manual/Makefile.am
6b8fee
@@ -1,14 +1,20 @@
6b8fee
+XSLTPROC_FLAGS = --path $(abs_builddir):$(abs_srcdir):$(abs_builddir)/doc
6b8fee
 
6b8fee
 man8_MANS += \
6b8fee
 	doc/manual/realm.8
6b8fee
 man5_MANS += \
6b8fee
 	doc/manual/realmd.conf.5
6b8fee
 
6b8fee
+$(man5_MANS): doc/privatedir.xml
6b8fee
+
6b8fee
 MAN_IN_FILES = \
6b8fee
 	$(man8_MANS:.8=.xml) \
6b8fee
 	$(man5_MANS:.5=.xml) \
6b8fee
 	$(NULL)
6b8fee
 
6b8fee
+doc/privatedir.xml: doc/privatedir.xml.in
6b8fee
+	$(V_SED) $(MKDIR_P) $(dir $@) && $(SED_SUBST) $< > $@
6b8fee
+
6b8fee
 MANUAL_DOCBOOK = doc/manual/realmd-docs.xml
6b8fee
 
6b8fee
 MANUAL_INCLUDES = \
6b8fee
@@ -41,6 +47,7 @@ MANUAL_XSLT = \
6b8fee
 	$(NULL)
6b8fee
 
6b8fee
 EXTRA_DIST += \
6b8fee
+	doc/privatedir.xml.in \
6b8fee
 	$(MANUAL_DOCBOOK) \
6b8fee
 	$(MANUAL_INCLUDES) \
6b8fee
 	$(MAN_IN_FILES) \
6b8fee
@@ -50,6 +57,7 @@ EXTRA_DIST += \
6b8fee
 
6b8fee
 CLEANFILES += \
6b8fee
 	realmd-org.freedesktop.realmd.generated \
6b8fee
+	doc/privatedir.xml \
6b8fee
 	$(DBUS_DOC_GENERATED) \
6b8fee
 	$(DBUS_ESCAPED) \
6b8fee
 	$(man8_MANS) \
6b8fee
diff --git a/doc/manual/realmd.conf.xml b/doc/manual/realmd.conf.xml
6b8fee
index 1592291..9062252 100644
6b8fee
--- a/doc/manual/realmd.conf.xml
6b8fee
+++ b/doc/manual/realmd.conf.xml
6b8fee
@@ -1,6 +1,9 @@
6b8fee
 
6b8fee
 
6b8fee
-        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
6b8fee
+        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
6b8fee
+[
6b8fee
+
6b8fee
+]>
6b8fee
 
6b8fee
 <refentry id="realmd-conf">
6b8fee
 
6b8fee
@@ -35,7 +38,9 @@
6b8fee
 	to act in specific ways. This is done by placing settings in a
6b8fee
 	<filename>/etc/realmd.conf</filename>. This file does not exist by
6b8fee
 	default. The syntax of this file is the same as an INI file or
6b8fee
-	Desktop Entry file.</para>
6b8fee
+	Desktop Entry file. If the file is changed and
6b8fee
+	<command>realmd</command> is running <command>realmd</command> must be
6b8fee
+	restarted to read the new values.</para>
6b8fee
 
6b8fee
 	<para>In general, settings in this file only apply at the point of
6b8fee
 	joining a domain or realm. Once the realm has been setup the settings
6b8fee
@@ -46,8 +51,10 @@
6b8fee
 
6b8fee
 	<para>Only specify the settings you wish to override in the
6b8fee
 	<filename>/etc/realmd.conf</filename> file. Settings not specified will
6b8fee
-	be loaded from their packaged defaults. Only override the settings
6b8fee
-	below. You may find other settings if you look through the
6b8fee
+	be loaded from their packaged defaults which can be found in
6b8fee
+	<filename>&privatedir;/realmd-defaults.conf</filename> and
6b8fee
+	<filename>&privatedir;/realmd-distro.conf</filename>. Only override the
6b8fee
+	settings below. You may find other settings if you look through the
6b8fee
 	<command>realmd</command> source code. However these are not guaranteed
6b8fee
 	to remain stable.</para>
6b8fee
 
6b8fee
diff --git a/doc/privatedir.xml.in b/doc/privatedir.xml.in
6b8fee
new file mode 100644
6b8fee
index 0000000..7f71afe
6b8fee
--- /dev/null
6b8fee
+++ b/doc/privatedir.xml.in
6b8fee
@@ -0,0 +1 @@
6b8fee
+@privatedir@
6b8fee
\ No newline at end of file
6b8fee
-- 
6b8fee
2.21.0
6b8fee