shaba/systemd-stable
1
1
Fork 0
mirror of https://github.com/systemd/systemd-stable.git synced 2025-02-27 13:57:26 +03:00
Code

man: don't document systemctl --failed

Browse Source 
This effectively reverts 599b6322f19ec619ddc294d0e7880b669040cf66, which
in turn partially reverted 4dc5b821ae737914499119e29811fc3346e3d97c.

The --failed switch is not documented on purpose, since it is redundant
due to --state=failed, which it predates. Due to that it's not
documented in --help either.

We generally try to avoid redundant interfaces, but if we need to keep
them for compatibility we do so, however remove them from documentation
to ensure they are not used in future.

The man page is now changed to include a comment about the fact that
--failed is not documented on purpose. Also, explicitly mention
--state=failed as example for --state.
This commit is contained in:
Lennart Poettering 2014-11-10 14:44:35 +01:00
parent 5445c7a002
commit 036359ba8d
1 changed files with 8 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
man/systemctl.xml
View File

@ -98,9 +98,10 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
<term><option>--state=</option></term> <term><option>--state=</option></term>
<listitem> <listitem>
<para>The argument should be a comma-separated list of unit LOAD, <para>The argument should be a comma-separated list of unit
SUB, or ACTIVE states. When listing units, show only those LOAD, SUB, or ACTIVE states. When listing units, show only
in specified states.</para> those in specified states. Use <option>--state=failed</option>
to show only failed units.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -321,14 +322,10 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
<xi:include href="user-system-options.xml" xpointer="user" /> <xi:include href="user-system-options.xml" xpointer="user" />
<xi:include href="user-system-options.xml" xpointer="system" /> <xi:include href="user-system-options.xml" xpointer="system" />
<varlistentry> <!-- we do not document -failed here, as it has been made
<term><option>--failed</option></term> redundant by -state=failed, which it predates. To keep
things simple we only document the new switch, while
<listitem> keeping the old one around for compatibility only. -->
<para>List units in failed state. This is equivalent to
<option>--state=failed</option>.</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>--no-wall</option></term> <term><option>--no-wall</option></term>