summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2014-07-01 00:16:17 +0200
committerLennart Poettering <lennart@poettering.net>2014-07-01 00:16:48 +0200
commit7caa86ac4d19f65e396d759bfb02b96646fc09eb (patch)
treeda4c57b89e64be9dab2c6a0b3c42e2a1477f2dc9
parentdc7f577501278633be6abb0600df8a21561f6640 (diff)
man: document systemd-update-done.service
-rw-r--r--Makefile-man.am7
-rw-r--r--man/systemd-update-done.service.xml101
-rw-r--r--units/systemd-update-done.service.in2
3 files changed, 109 insertions, 1 deletions
diff --git a/Makefile-man.am b/Makefile-man.am
index 38a395eff9..3840bb138d 100644
--- a/Makefile-man.am
+++ b/Makefile-man.am
@@ -87,6 +87,7 @@ MANPAGES += \
man/systemd-tmpfiles.8 \
man/systemd-tty-ask-password-agent.1 \
man/systemd-udevd.service.8 \
+ man/systemd-update-done.service.8 \
man/systemd-update-utmp.service.8 \
man/systemd.1 \
man/systemd.automount.5 \
@@ -217,6 +218,7 @@ MANPAGES_ALIAS += \
man/systemd-udevd-control.socket.8 \
man/systemd-udevd-kernel.socket.8 \
man/systemd-udevd.8 \
+ man/systemd-update-done.8 \
man/systemd-update-utmp-runlevel.service.8 \
man/systemd-update-utmp.8 \
man/systemd-user.conf.5
@@ -321,6 +323,7 @@ man/systemd-tmpfiles-setup.service.8: man/systemd-tmpfiles.8
man/systemd-udevd-control.socket.8: man/systemd-udevd.service.8
man/systemd-udevd-kernel.socket.8: man/systemd-udevd.service.8
man/systemd-udevd.8: man/systemd-udevd.service.8
+man/systemd-update-done.8: man/systemd-update-done.service.8
man/systemd-update-utmp-runlevel.service.8: man/systemd-update-utmp.service.8
man/systemd-update-utmp.8: man/systemd-update-utmp.service.8
man/systemd-user.conf.5: man/systemd-system.conf.5
@@ -627,6 +630,9 @@ man/systemd-udevd-kernel.socket.html: man/systemd-udevd.service.html
man/systemd-udevd.html: man/systemd-udevd.service.html
$(html-alias)
+man/systemd-update-done.html: man/systemd-update-done.service.html
+ $(html-alias)
+
man/systemd-update-utmp-runlevel.service.html: man/systemd-update-utmp.service.html
$(html-alias)
@@ -1633,6 +1639,7 @@ EXTRA_DIST += \
man/systemd-tmpfiles.xml \
man/systemd-tty-ask-password-agent.xml \
man/systemd-udevd.service.xml \
+ man/systemd-update-done.service.xml \
man/systemd-update-utmp.service.xml \
man/systemd-user-sessions.service.xml \
man/systemd-vconsole-setup.service.xml \
diff --git a/man/systemd-update-done.service.xml b/man/systemd-update-done.service.xml
new file mode 100644
index 0000000000..a791beae62
--- /dev/null
+++ b/man/systemd-update-done.service.xml
@@ -0,0 +1,101 @@
+<?xml version="1.0"?>
+<!--*-nxml-*-->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<!--
+ This file is part of systemd.
+
+ Copyright 2014 Lennart Poettering
+
+ systemd is free software; you can redistribute it and/or modify it
+ under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation; either version 2.1 of the License, or
+ (at your option) any later version.
+
+ systemd is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with systemd; If not, see <http://www.gnu.org/licenses/>.
+-->
+<refentry id="systemd-update-done.service">
+
+ <refentryinfo>
+ <title>systemd-update-done.service</title>
+ <productname>systemd</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Lennart</firstname>
+ <surname>Poettering</surname>
+ <email>lennart@poettering.net</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>systemd-update-done.service</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>systemd-update-done.service</refname>
+ <refname>systemd-update-done</refname>
+ <refpurpose>Mark <filename>/etc</filename> and <filename>/var</filename> fully updated</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <para><filename>systemd-update-done.service</filename></para>
+ <para><filename>/usr/lib/systemd/systemd-update-done</filename></para>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para><filename>systemd-update-done.service</filename>
+ is a service that is invoked as part of the first boot
+ after the vendor operating system resources in
+ <filename>/usr</filename> have been updated. This is
+ useful to implement offline updates of
+ <filename>/usr</filename> which might requires updates
+ to <filename>/etc</filename> or
+ <filename>/var</filename> on the following boot.</para>
+
+ <para><filename>systemd-update-done.service</filename>
+ updates the file modification time (mtime) of the
+ stamp files <filename>/etc/.updated</filename> and
+ <filename>/var/.updated</filename> to the modification
+ time of the <filename>/usr</filename> directory,
+ unless the stamp files are already newer.</para>
+
+ <para>Services that shall run after offline upgrades
+ of <filename>/usr</filename> should order themselves
+ before
+ <filename>systemd-update-done.service</filename>, and
+ use the <varname>ConditionNeedsUpdate=</varname> (see
+ <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
+ condition to make sure to run when
+ <filename>/etc</filename> or <filename>/var</filename>
+ are older than <filename>/usr</filename> according to
+ the modification times of the files described
+ above. This requires that updates to
+ <filename>/usr</filename> are always followed by an
+ update of the modification time of
+ <filename>/usr</filename>, for example by invoking
+ <citerefentry><refentrytitle>touch</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+ on it.</para>
+
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+ <para>
+ <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>touch</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+ </para>
+ </refsect1>
+
+</refentry>
diff --git a/units/systemd-update-done.service.in b/units/systemd-update-done.service.in
index f75fcff578..7031bff614 100644
--- a/units/systemd-update-done.service.in
+++ b/units/systemd-update-done.service.in
@@ -7,7 +7,7 @@
[Unit]
Description=Update is Completed
-Documentation=man:sysusers.d(5) man:systemd-sysusers(8)
+Documentation=man:systemd-update-done.service(8)
DefaultDependencies=no
Conflicts=shutdown.target
After=systemd-readahead-collect.service systemd-readahead-replay.service local-fs.target