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

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