From: Lennart Poettering <lennart@poettering.net>
Date: Wed, 27 Jun 2012 13:12:29 +0000 (+0200)
Subject: man: document systemd-update-generator
X-Git-Tag: v186~59
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=commitdiff_plain;h=f5ccf26ded1fd7c3d5d9c7b6615236ae051b4a34

man: document systemd-update-generator
---

diff --git a/Makefile.am b/Makefile.am
index acbdeedd1..239dc6304 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -498,7 +498,8 @@ MANPAGES = \
 	man/systemd-ask-password-console.service.8 \
 	man/systemd-analyze.1 \
 	man/systemd-tty-ask-password-agent.1 \
-	man/systemd-getty-generator.8
+	man/systemd-getty-generator.8 \
+	man/systemd-system-update-generator.8
 
 MANPAGES_ALIAS = \
 	man/reboot.8 \
diff --git a/man/systemd-system-update-generator.xml b/man/systemd-system-update-generator.xml
new file mode 100644
index 000000000..3a0a505ec
--- /dev/null
+++ b/man/systemd-system-update-generator.xml
@@ -0,0 +1,79 @@
+<?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 2012 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-system-update-generator">
+
+        <refentryinfo>
+                <title>systemd-system-update-generator</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-system-update-generator</refentrytitle>
+                <manvolnum>8</manvolnum>
+        </refmeta>
+
+        <refnamediv>
+                <refname>systemd-system-update-generator</refname>
+                <refpurpose>Generator for redirecting boot to offline update mode</refpurpose>
+        </refnamediv>
+
+        <refsynopsisdiv>
+                <para><filename>/usr/lib/systemd/system-generators/systemd-system-update-generator</filename></para>
+        </refsynopsisdiv>
+
+        <refsect1>
+                <title>Description</title>
+
+                <para><filename>systemd-system-update-generator</filename>
+                is a generator that automatically redirects the boot
+                process to <filename>system-update.target</filename>
+                if <filename>/system-update</filename> exists. This is
+                required to implement the logic explained in the
+                <ulink
+                url="http://freedesktop.org/wiki/Software/systemd/SystemUpdates">System
+                Updates Specification</ulink>.
+                </para>
+
+                <para><filename>systemd-system-update-generator</filename>
+                implements the <ulink
+                url="http://www.freedesktop.org/wiki/Software/systemd/Generator">generator
+                specification</ulink>.</para>
+        </refsect1>
+
+        <refsect1>
+                <title>See Also</title>
+                <para>
+                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+                </para>
+        </refsect1>
+
+</refentry>
diff --git a/man/systemd.special.xml b/man/systemd.special.xml
index fdb202037..396697be9 100644
--- a/man/systemd.special.xml
+++ b/man/systemd.special.xml
@@ -96,6 +96,7 @@
                 <filename>syslog.service</filename>,
                 <filename>syslog.socket</filename>,
                 <filename>syslog.target</filename>,
+                <filename>system-update.target</filename>,
                 <filename>time-sync.target</filename>,
                 <filename>umount.target</filename></para>
         </refsynopsisdiv>
@@ -764,6 +765,23 @@
                                         facility.</para>
                                 </listitem>
                         </varlistentry>
+                        <varlistentry>
+                                <term><filename>system-update.target</filename></term>
+                                <listitem>
+                                        <para>A special target unit
+                                        that is used for off-line
+                                        system updates.
+                                        <citerefentry><refentrytitle>systemd-system-update-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                                        will redirect the boot process
+                                        to this target if
+                                        <filename>/system-update</filename>
+                                        exists. For more information
+                                        see the <ulink
+                                        url="http://freedesktop.org/wiki/Software/systemd/SystemUpdates">System
+                                        Updates
+                                        Specification</ulink>.</para>
+                                </listitem>
+                        </varlistentry>
                         <varlistentry>
                                 <term><filename>time-sync.target</filename></term>
                                 <listitem>
@@ -795,6 +813,7 @@
                                         is set (the default).</para>
                                 </listitem>
                         </varlistentry>
+
                 </variablelist>
         </refsect1>
 
diff --git a/units/serial-getty@.service.m4 b/units/serial-getty@.service.m4
index d61f93cec..fa386ea0d 100644
--- a/units/serial-getty@.service.m4
+++ b/units/serial-getty@.service.m4
@@ -7,7 +7,7 @@
 
 [Unit]
 Description=Serial Getty on %I
-Documentation=man:agetty(8)
+Documentation=man:agetty(8) man:systemd-getty-generator(8)
 BindTo=dev-%i.device
 After=dev-%i.device systemd-user-sessions.service plymouth-quit-wait.service
 m4_ifdef(`TARGET_FEDORA',
diff --git a/units/system-update.target b/units/system-update.target
index 381f3f9a6..d0f847f95 100644
--- a/units/system-update.target
+++ b/units/system-update.target
@@ -8,7 +8,7 @@
 [Unit]
 Description=System Update
 Documentation=http://freedesktop.org/wiki/Software/systemd/SystemUpdates
-Documentation=man:systemd.special(7)
+Documentation=man:systemd.special(7) man:systemd-system-update-generator(8)
 Requires=sysinit.target
 Conflicts=shutdown.target systemd-readahead-collect.service systemd-readahead-replay.service
 After=sysinit.target