Merge pull request #1831 from keszybz/todo-trimming

Todo trimming

3 files changed, 56 insertions, 18 deletions

diff --git a/TODO b/TODO
index f4b5fb3c54..42534989a6 100644
--- a/TODO
+++ b/TODO
@@ -21,9 +21,6 @@ External:
 
 * wiki: update journal format documentation for lz4 additions
 
-* When lz4 gets an API for lz4 command output, make use of it to
-  compress coredumps in a way compatible with /usr/bin/lz4.
-
 Janitorial Clean-ups:
 
 * code cleanup: retire FOREACH_WORD_QUOTED, port to extract_first_word() loops instead
@@ -77,8 +74,6 @@ Features:
 
 * man: document that unless you use StandardError=null the shell >/dev/stderr won't work in shell scripts in services
 
-* man: clarify that "machinectl show" shows different information than "machinectl status" (no cgroup tree, no IP addresses, ...)
-
 * "systemctl daemon-reload" should result in /etc/systemd/system.conf being reloaded by systemd
 
 * install: include generator dirs in unit file search paths
@@ -601,7 +596,6 @@ Features:
   - add API to close/reopen/get fd for journal client fd in libsystemd-journal.
   - fallback to /dev/log based logging in libsystemd-journal, if we cannot log natively?
   - declare the local journal protocol stable in the wiki interface chart
-  - journal: reuse XZ context
   - sd-journal: speed up sd_journal_get_data() with transparent hash table in bg
   - journald: when dropping msgs due to ratelimit make sure to write
     "dropped %u messages" not only when we are about to print the next
@@ -655,7 +649,6 @@ Features:
   - document systemd-journal-flush.service properly
   - documentation: recommend to connect the timer units of a service to the service via Also= in [Install]
   - man: document the very specific env the shutdown drop-in tools live in
-  - man: extend runlevel(8) to mention that runlevels suck, and are dead. Maybe add runlevel(7) with a note about that too
   - man: add more examples to man pages
   - man: maybe sort directives in man pages, and take sections from --help and apply them to man too
 
diff --git a/man/machinectl.xml b/man/machinectl.xml
index d1da7f60a6..0e18953700 100644
--- a/man/machinectl.xml
+++ b/man/machinectl.xml
@@ -317,7 +317,7 @@
       <varlistentry>
         <term><command>status</command> <replaceable>NAME</replaceable>...</term>
 
-        <listitem><para>Show terse runtime status information about
+        <listitem><para>Show runtime status information about
         one or more virtual machines and containers, followed by the
         most recent log data from the journal. This function is
         intended to generate human-readable output. If you are looking
@@ -339,7 +339,8 @@
         are suppressed. Use <option>--all</option> to show those too.
         To select specific properties to show, use
         <option>--property=</option>. This command is intended to be
-        used whenever computer-parsable output is required. Use
+        used whenever computer-parsable output is required, and does
+        not print the cgroup tree or journal entries. Use
         <command>status</command> if you are looking for formatted
         human-readable output.</para></listitem>
       </varlistentry>
diff --git a/man/runlevel.xml b/man/runlevel.xml
index fc1f523855..ca29c7c22c 100644
--- a/man/runlevel.xml
+++ b/man/runlevel.xml
@@ -51,11 +51,62 @@
 
   <refsynopsisdiv>
     <cmdsynopsis>
-      <command>runlevel <arg choice="opt" rep="repeat">options</arg></command>
+      <command>runlevel</command>
+      <arg choice="opt" rep="repeat">options</arg>
     </cmdsynopsis>
   </refsynopsisdiv>
 
   <refsect1>
+    <title>Overview</title>
+
+    <para>"Runlevels" are an obsolete way to start and stop groups of
+    services used in SysV init. systemd provides a compatibility layer
+    that maps runlevels to targets, and associated binaries like
+    <command>runlevel</command>. Nevertheless, only one runlevel can
+    be "active" at a given time, while systemd can activate multiple
+    targets concurrently, so the mapping to runlevels is confusing
+    and only approximate. Runlevels should not be used in new code,
+    and are mostly useful as a shorthand way to refer the matching
+    systemd targets in kernel boot parameters.</para>
+
+    <table>
+      <title>Mapping between runlevels and systemd targets</title>
+      <tgroup cols='2' align='left' colsep='1' rowsep='1'>
+        <colspec colname="runlevel" />
+        <colspec colname="target" />
+        <thead>
+          <row>
+            <entry>Runlevel</entry>
+            <entry>Target</entry>
+          </row>
+        </thead>
+        <tbody>
+          <row>
+            <entry>0</entry>
+            <entry><filename>poweroff.target</filename></entry>
+          </row>
+          <row>
+            <entry>1</entry>
+            <entry><filename>rescue.target</filename></entry>
+          </row>
+          <row>
+            <entry>2, 3, 4</entry>
+            <entry><filename>multi-user.target</filename></entry>
+          </row>
+          <row>
+            <entry>5</entry>
+            <entry><filename>graphical.target</filename></entry>
+          </row>
+          <row>
+            <entry>6</entry>
+            <entry><filename>reboot.target</filename></entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </table>
+  </refsect1>
+
+  <refsect1>
     <title>Description</title>
 
     <para><command>runlevel</command> prints the previous and current
@@ -130,17 +181,10 @@
   </refsect1>
 
   <refsect1>
-    <title>Notes</title>
-
-    <para>This is a legacy command available for compatibility only.
-    It should not be used anymore, as the concept of runlevels is
-    obsolete.</para>
-  </refsect1>
-
-  <refsect1>
     <title>See Also</title>
     <para>
       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
     </para>
   </refsect1>