docs: install README files into /var/log and 7etc/rc.d/init.d

poettering · poettering · commit 0ce8860a15fb · 2012-10-17T21:25:42.000+02:00
On systemd systems seasoned admins might be surprised to see that the
init scripts and log files are gone. To ease the transition let's place
some README files there, that hopefully help clearing up the situation.
diff --git a/Makefile.am b/Makefile.am
@@ -61,6 +61,8 @@ pkgconfiglibdir=$(libdir)/pkgconfig
 polkitpolicydir=$(datadir)/polkit-1/actions
 bashcompletiondir=$(sysconfdir)/bash_completion.d
 rpmmacrosdir=$(sysconfdir)/rpm
+sysvinitdir=$(SYSTEM_SYSVINIT_PATH)
+varlogdir=$(localstatedir)/log
 
 # Our own, non-special dirs
 pkgsysconfdir=$(sysconfdir)/systemd
@@ -3594,6 +3596,8 @@ SED_PROCESS = \
 		-e 's,@sushell\@,$(sushell),g' \
 		-e 's,@QUOTAON\@,$(QUOTAON),g' \
 		-e 's,@QUOTACHECK\@,$(QUOTACHECK),g' \
+		-e 's,@SYSTEM_SYSVINIT_PATH\@,$(sysvinitdir),g' \
+		-e 's,@VARLOGDIR\@,$(varlogdir),g' \
 		< $< > $@
 
 units/%: units/%.in Makefile
@@ -3704,6 +3708,26 @@ DBUS_PREPROCESS = $(CPP) -P $(CFLAGS) $(DBUS_CFLAGS) -imacros dbus/dbus-protocol
 CLEANFILES += \
 	$(dbusinterface_DATA)
 
+if HAVE_SYSV_COMPAT
+sysvinit_DATA = \
+	docs/sysvinit/README
+
+varlog_DATA = \
+	docs/var-log/README
+
+docs/sysvinit/README: docs/sysvinit/README.in
+	$(SED_PROCESS)
+
+docs/var-log/README: docs/var-log/README.in
+	$(SED_PROCESS)
+
+EXTRA_DIST += \
+	docs/sysvinit/README.in \
+	docs/var-log/README.in
+
+endif
+
+
 systemd-install-data-hook:
 	$(MKDIR_P) -m 0755 \
 		$(DESTDIR)$(tmpfilesdir) \
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1 @@
+../src/Makefile
diff --git a/docs/sysvinit/.gitignore b/docs/sysvinit/.gitignore
@@ -0,0 +1 @@
+/README
diff --git a/docs/sysvinit/Makefile b/docs/sysvinit/Makefile
@@ -0,0 +1 @@
+../../src/Makefile
diff --git a/docs/sysvinit/README.in b/docs/sysvinit/README.in
@@ -0,0 +1,27 @@
+You are looking for the traditional init scripts in @SYSTEM_SYSVINIT_PATH@,
+and they are gone?
+
+Here's an explanation on what's going on:
+
+You are running a systemd-based OS where traditional init scripts have
+been replaced by native systemd services files. Service files provide
+very similar functionality to init scripts. To make use of service
+files simply invoke "systemctl", which will output a list of all
+currently running services (and other units). Use "systemctl
+list-unit-files" to get a listing of all known unit files, including
+stopped, disabled and masked ones. Use "systemctl start
+foobar.service" and "systemctl stop foobar.service" to start or stop a
+service, respectively. For further details, please refer to
+systemctl(1).
+
+Note that traditional init scripts continue to function on a systemd
+system. An init script @SYSTEM_SYSVINIT_PATH@/foobar is implicitly mapped
+into a service unit foobar.service during system initialization.
+
+Thank you!
+
+Further reading:
+        man:systemctl(1)
+        man:systemd(1)
+        http://0pointer.de/blog/projects/systemd-for-admins-3.html
+        http://www.freedesktop.org/wiki/Software/systemd/Incompatibilities
diff --git a/docs/var-log/.gitignore b/docs/var-log/.gitignore
@@ -0,0 +1 @@
+/README
diff --git a/docs/var-log/Makefile b/docs/var-log/Makefile
@@ -0,0 +1 @@
+../../src/Makefile
diff --git a/docs/var-log/README.in b/docs/var-log/README.in
@@ -0,0 +1,26 @@
+You are looking for the traditional text log files in @VARLOGDIR@, and
+they are gone?
+
+Here's an explanation on what's going on:
+
+You are running a systemd-based OS where traditional syslog has been
+replaced with the Journal. The journal stores the same (and more)
+information as classic syslog. To make use of the journal and access
+the collected log data simply invoke "journalctl", which will output
+the logs in the identical text-based format the syslog files in
+@VARLOGDIR@ used to be. For further details, please refer to
+journalctl(1).
+
+Alternatively, consider installing one of the traditional syslog
+implementations available for your distribution, which will generate
+the classic log files for you. Syslog implementations such as
+syslog-ng or rsyslog may be installed side-by-side with the journal
+and will continue to function the way they always did.
+
+Thank you!
+
+Further reading:
+        man:journalctl(1)
+        man:systemd-journald.service(8)
+        man:journald.conf(5)
+        http://0pointer.de/blog/projects/the-journal.html
