From: Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Date: Fri, 26 Mar 2021 07:43:03 +0000 (+0100)
Subject: config files: recommend systemd-analyze cat-config
X-Git-Tag: v248-2~13^2~1
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=3b0754b16c5535fd48f48ca39f69335ef695efe7;p=thirdparty%2Fsystemd.git

config files: recommend systemd-analyze cat-config

This adds the same line to most of our .conf files.

Not for systemd/user.conf though, since we can't correctly display it right
now:
$ systemd-analyze cat-config --user systemd/user.conf
Option --user is not supported for cat-config right now.

For sysusers.d, tmpfiles.d, rules.d, etc, there is no single file. Maybe
we should short READMEs in /usr/lib/sysusers.d, /usr/lib/tmpfiles.d, etc.?

Inspired by #19118.
---

diff --git a/src/core/system.conf.in b/src/core/system.conf.in
index b8805b02fa3..fa6fb690c78 100644
--- a/src/core/system.conf.in
+++ b/src/core/system.conf.in
@@ -10,6 +10,8 @@
 # the system.conf.d/ subdirectory. The latter is generally recommended.
 # Defaults can be restored by simply deleting this file and all drop-ins.
 #
+# Use 'systemd-analyze cat-config systemd/system.conf' to display the full config.
+#
 # See systemd-system.conf(5) for details.
 
 [Manager]
diff --git a/src/coredump/coredump.conf b/src/coredump/coredump.conf
index 738c45bed25..56c10082452 100644
--- a/src/coredump/coredump.conf
+++ b/src/coredump/coredump.conf
@@ -10,6 +10,8 @@
 # the system.conf.d/ subdirectory. The latter is generally recommended.
 # Defaults can be restored by simply deleting this file and all drop-ins.
 #
+# Use 'systemd-analyze cat-config systemd/coredump.conf' to display the full config.
+#
 # See coredump.conf(5) for details.
 
 [Coredump]
diff --git a/src/home/homed.conf b/src/home/homed.conf
index 86b6266895c..ba854641df7 100644
--- a/src/home/homed.conf
+++ b/src/home/homed.conf
@@ -10,6 +10,8 @@
 # the system.conf.d/ subdirectory. The latter is generally recommended.
 # Defaults can be restored by simply deleting this file and all drop-ins.
 #
+# Use 'systemd-analyze cat-config systemd/homed.conf' to display the full config.
+#
 # See homed.conf(5) for details.
 
 [Home]
diff --git a/src/journal/journald.conf b/src/journal/journald.conf
index ee674ebefed..18d6b30773b 100644
--- a/src/journal/journald.conf
+++ b/src/journal/journald.conf
@@ -10,6 +10,8 @@
 # the system.conf.d/ subdirectory. The latter is generally recommended.
 # Defaults can be restored by simply deleting this file and all drop-ins.
 #
+# Use 'systemd-analyze cat-config systemd/journald.conf' to display the full config.
+#
 # See journald.conf(5) for details.
 
 [Journal]
diff --git a/src/login/logind.conf.in b/src/login/logind.conf.in
index 800c452a60f..76f529c176b 100644
--- a/src/login/logind.conf.in
+++ b/src/login/logind.conf.in
@@ -10,6 +10,8 @@
 # the system.conf.d/ subdirectory. The latter is generally recommended.
 # Defaults can be restored by simply deleting this file and all drop-ins.
 #
+# Use 'systemd-analyze cat-config systemd/logind.conf' to display the full config.
+#
 # See logind.conf(5) for details.
 
 [Login]
diff --git a/src/oom/oomd.conf b/src/oom/oomd.conf
index f1bef9de6fb..d1dca0d64d1 100644
--- a/src/oom/oomd.conf
+++ b/src/oom/oomd.conf
@@ -10,6 +10,8 @@
 # the system.conf.d/ subdirectory. The latter is generally recommended.
 # Defaults can be restored by simply deleting this file and all drop-ins.
 #
+# Use 'systemd-analyze cat-config systemd/oomd.conf' to display the full config.
+#
 # See oomd.conf(5) for details
 
 [OOM]
diff --git a/src/resolve/resolved.conf.in b/src/resolve/resolved.conf.in
index 33187618e5c..f88a4e97c0d 100644
--- a/src/resolve/resolved.conf.in
+++ b/src/resolve/resolved.conf.in
@@ -10,6 +10,8 @@
 # the system.conf.d/ subdirectory. The latter is generally recommended.
 # Defaults can be restored by simply deleting this file and all drop-ins.
 #
+# Use 'systemd-analyze cat-config systemd/resolved.conf' to display the full config.
+#
 # See resolved.conf(5) for details.
 
 [Resolve]