From: Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Date: Wed, 10 Apr 2019 08:12:43 +0000 (+0200)
Subject: man: add a page for systemd-udev-settle.service
X-Git-Tag: v243-rc1~567^2~1
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=18a388225035c0ed9897e0327006b501424249df;p=thirdparty%2Fsystemd.git

man: add a page for systemd-udev-settle.service
---

diff --git a/man/rules/meson.build b/man/rules/meson.build
index d949900ddc4..762e72cabe5 100644
--- a/man/rules/meson.build
+++ b/man/rules/meson.build
@@ -774,6 +774,7 @@ manpages = [
    'systemd-tmpfiles-setup.service'],
   ''],
  ['systemd-tty-ask-password-agent', '1', [], ''],
+ ['systemd-udev-settle.service', '8', [], ''],
  ['systemd-udevd.service',
   '8',
   ['systemd-udevd',
diff --git a/man/systemd-udev-settle.service.xml b/man/systemd-udev-settle.service.xml
new file mode 100644
index 00000000000..6fbd99111f6
--- /dev/null
+++ b/man/systemd-udev-settle.service.xml
@@ -0,0 +1,51 @@
+<?xml version='1.0'?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<!-- SPDX-License-Identifier: LGPL-2.1+ -->
+
+<refentry id="systemd-udev-settle.service"
+          xmlns:xi="http://www.w3.org/2001/XInclude">
+
+  <refentryinfo>
+    <title>systemd-udev-settle.service</title>
+    <productname>systemd</productname>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle>systemd-udev-settle.service</refentrytitle>
+    <manvolnum>8</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>systemd-udev-settle.service</refname>
+    <refpurpose>Wait for all pending udev events to be handled</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <para><filename>systemd-udev-settle.service</filename></para>
+  </refsynopsisdiv>
+
+  <refsect1><title>Description</title>
+  <para>This service calls <command>udevadm settle</command> to wait until all events that have been queued
+  by <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry> have been
+  processed. It is a crude way to wait until "all" hardware has been discovered. Services may pull in this
+  service and order themselves after it to wait for the udev queue to be empty.</para>
+
+  <para><emphasis>Using this service is not recommended.</emphasis> There can be no guarantee that hardware
+  is fully discovered at any specific time, because the kernel does hardware detection asynchronously, and
+  certain busses and devices take a very long time to become ready, and also additional hardware may be
+  plugged in at any time. Instead, services should subscribe to udev events and react to any new hardware as
+  it is discovered. Services that, based on configuration, expect certain devices to appear, may warn or
+  report failure after a timeout. This timeout should be tailored to the hardware type. Waiting for
+  <filename>systemd-udev-settle.service</filename> usually slows boot significantly, because it means waiting
+  for all unrelated events too.</para>
+ </refsect1>
+
+  <refsect1>
+    <title>See Also</title>
+    <para>
+      <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+    </para>
+  </refsect1>
+</refentry>
diff --git a/man/udevadm.xml b/man/udevadm.xml
index 467402ca750..a591ab8c34d 100644
--- a/man/udevadm.xml
+++ b/man/udevadm.xml
@@ -362,6 +362,10 @@
 
         <xi:include href="standard-options.xml" xpointer="help" />
       </variablelist>
+
+      <para>See
+      <citerefentry><refentrytitle>systemd-udev-settle.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+      for more information.</para>
     </refsect2>
 
     <refsect2><title>udevadm control <replaceable>option</replaceable></title>
diff --git a/units/systemd-udev-settle.service.in b/units/systemd-udev-settle.service.in
index c9e1c918521..22ebf08c519 100644
--- a/units/systemd-udev-settle.service.in
+++ b/units/systemd-udev-settle.service.in
@@ -13,7 +13,7 @@
 
 [Unit]
 Description=udev Wait for Complete Device Initialization
-Documentation=man:udev(7) man:systemd-udevd.service(8)
+Documentation=man:systemd-udev-settle.service(8)
 DefaultDependencies=no
 Wants=systemd-udevd.service
 After=systemd-udev-trigger.service