[system-administrators-guide] ethtool | Markup improvements Seems, from the web, that ethtool should be lower case e when possible
stephenw
stephenw at fedoraproject.org
Fri Jul 26 11:38:25 UTC 2013
commit 15371f5050cc9ad3405776c323a375d0debc7737
Author: Stephen Wadeley <swadeley at redhat.com>
Date: Fri Jul 26 13:15:43 2013 +0200
ethtool | Markup improvements
Seems, from the web, that ethtool should be lower case e when possible.
en-US/Network_Interfaces.xml | 44 +++++++++++++----------------------------
1 files changed, 14 insertions(+), 30 deletions(-)
---
diff --git a/en-US/Network_Interfaces.xml b/en-US/Network_Interfaces.xml
index 259cd56..59d45af 100644
--- a/en-US/Network_Interfaces.xml
+++ b/en-US/Network_Interfaces.xml
@@ -656,10 +656,10 @@ ONBOOT=yes</programlisting>
<secondary>interfaces</secondary>
<tertiary>ethtool</tertiary>
</indexterm>
- <para>Ethtool is a utility for configuration of <firstterm>Network Interface Cards</firstterm> (<acronym>NICs</acronym>). This utility allows querying and changing settings such as speed, port, auto-negotiation, PCI locations and checksum offload on many network devices, especially Ethernet devices.
+ <para><application>Ethtool</application> is a utility for configuration of <firstterm>Network Interface Cards</firstterm> (<acronym>NICs</acronym>). This utility allows querying and changing settings such as speed, port, auto-negotiation, PCI locations and checksum offload on many network devices, especially Ethernet devices.
</para>
-<para>We present here a short selection of often used Ethtool commands together with some useful commands that are not well known. For a full list of commands type <command>ethtool -h</command> or refer to the man page, <filename>ethtool(8)</filename>, for a more verbose list and explanation. The first two examples are information queries and show the use of the different formats of the command.</para> <para>But first, the command structure:</para>
+<para>We present here a short selection of often used <application>ethtool</application> commands together with some useful commands that are not well known. For a full list of commands type <command>ethtool -h</command> or refer to the man page, <filename>ethtool(8)</filename>, for a more verbose list and explanation. The first two examples are information queries and show the use of the different formats of the command.</para> <para>But first, the command structure:</para>
<variablelist>
@@ -754,13 +754,7 @@ supports-test: yes
supports-eeprom-access: yes
supports-register-dump: yes </screen>
-
-
-
-
-<para>Here follows a list of commands to query, identify or reset the device. They are in the usual -short and --long form:</para>
-
-
+<para>Here follows a list of command options to query, identify or reset the device. They are in the usual <literal>-short</literal> and <literal>--long</literal> form:</para>
<variablelist>
@@ -809,8 +803,7 @@ supports-register-dump: yes </screen>
<para>
The <option>--identify</option> or <option>-p</option> option initiates adapter-specific action intended to enable an operator to easily identify the adapter by sight. Typically this involves blinking one or more LEDs on the specified network port. It takes the following form:
</para>
-<screen><option>-p, --identify
-</option><replaceable>devname</replaceable> <replaceable>integer</replaceable></screen>
+<screen><option>-p, --identify</option> <replaceable>devname</replaceable> <replaceable>integer</replaceable></screen>
<para>
where <replaceable>integer</replaceable> is length of time in seconds to perform the action,
</para>
@@ -839,8 +832,7 @@ The <option>--identify</option> or <option>-p</option> option initiates adapter-
<para>
The <option>--test</option> or <option>-t</option> option is used to perform tests on a Network Interface Card. It takes the following form:
</para>
-<screen><option>-t, --test</option> <replaceable>word </replaceable><replaceable>devname</replaceable></screen>
-
+<screen><option>-t, --test</option> <replaceable>word</replaceable> <replaceable>devname</replaceable></screen>
<para>
where <replaceable>word</replaceable> is one of the following:
</para>
@@ -875,7 +867,7 @@ The <option>--identify</option> or <option>-p</option> option initiates adapter-
<para>Changing some or all settings of the specified network device requires the <option>-s</option> or <option>--change</option> option. All the following options are only applied if the <option>-s</option> or <option>--change</option> option is also specified. For the sake of clarity we will omit it here.
</para>
<para>
- To make these settings permanent you can make use of the ETHTOOL_OPTS directive. It can be used in interface configuration files to set the desired options when the network interface is brought up. Refer to <xref linkend="s2-networkscripts-interfaces-eth0"/> for more details on how to use this directive.
+ To make these settings permanent you can make use of the <option>ETHTOOL_OPTS</option> directive. It can be used in interface configuration files to set the desired options when the network interface is brought up. Refer to <xref linkend="s2-networkscripts-interfaces-eth0"/> for more details on how to use this directive.
</para>
<variablelist>
@@ -1085,14 +1077,9 @@ The <option>--identify</option> or <option>-p</option> option initiates adapter-
<para>
It takes the following form:
</para>
-<screen><option>--advertise</option> <replaceable>HEX-VALUE</replaceable> <replaceable>devname</replaceable></screen>
-
-
+<screen><option>--advertise</option> <replaceable>option</replaceable> <replaceable>devname</replaceable></screen>
<para>
- where <replaceable>HEX-VALUE</replaceable> is one or more of the hexadecimal values from the table below and <replaceable>devname</replaceable> is your NIC.</para>
-
-
-
+ where <replaceable>option</replaceable> is one or more of the hexadecimal values from the table below and <replaceable>devname</replaceable> is your NIC.</para>
<table id="advertised-speeds-duplex-mode" frame="all">
<title>Ethtool advertise options: speed and mode of operation</title>
<tgroup cols="4" align="left" colsep="1" rowsep="1">
@@ -1309,10 +1296,9 @@ Yes</entry>
<para>
It takes the following form:
</para>
- <screen><option>--phyad</option> <replaceable>HEX-VALUE</replaceable> <replaceable>devname</replaceable></screen>
-
+ <screen><option>--phyad</option> <replaceable>physical_address</replaceable> <replaceable>devname</replaceable></screen>
<para>
- where <replaceable>HEX-VALUE</replaceable> is the physical address in hexadecimal format and <replaceable>devname</replaceable> is your NIC.
+ where <replaceable>physical_address</replaceable> is the physical address in hexadecimal format and <replaceable>devname</replaceable> is your NIC.
</para>
</listitem>
@@ -1482,21 +1468,19 @@ Yes</entry>
<para>
It takes the following form:
</para>
- <screen><option>--msglvl</option> <replaceable>value</replaceable> <replaceable>devname</replaceable></screen>
-
-
+ <screen><option>--msglvl</option> <replaceable>message_type</replaceable> <replaceable>devname</replaceable></screen>
<para>
- where <replaceable>value</replaceable> is one of:
+ where <replaceable>message_type</replaceable> is one of:
<itemizedlist>
<listitem>
<para>
- <literal>HEX-VALUE</literal> — Hexadecimal value indicating message type.
+ message type name in plain text.
</para>
</listitem>
<listitem>
<para>
- <literal>message-type</literal> — The message type name in plain text.
+ hexadecimal number indicating the message type.
</para>
</listitem>
</itemizedlist>
More information about the docs-commits
mailing list