From: Ben Hutchings <bhutchings@solarflare.com>
To: <netdev@vger.kernel.org>
Cc: <linux-net-drivers@solarflare.com>
Subject: [PATCH ethtool 05/21] ethtool.8: Change device name metavariable from 'ethX' to 'devname'
Date: Tue, 1 Nov 2011 23:15:02 +0000 [thread overview]
Message-ID: <1320189302.2758.35.camel@bwh-desktop> (raw)
In-Reply-To: <1320186901.2758.30.camel@bwh-desktop>
The name 'ethX' is a poor choice because:
- Many ethtool options are applicable to non-Ethernet devices
- Ethernet device names don't have to begin with 'eth', and the
new convention is to use the prefix 'lan' for LAN-on-motherboard
or 'pci' for PCI plug-in cards
The online help text already uses 'DEVNAME' instead, so change the
manual page to be consistent.
Signed-off-by: Ben Hutchings <bhutchings@solarflare.com>
---
ethtool.8.in | 62 +++++++++++++++++++++++++++++-----------------------------
1 files changed, 31 insertions(+), 31 deletions(-)
diff --git a/ethtool.8.in b/ethtool.8.in
index 286d089..65392d6 100644
--- a/ethtool.8.in
+++ b/ethtool.8.in
@@ -123,26 +123,26 @@ ethtool \- query or control network driver and hardware settings
.nh
.HP
.B ethtool
-.I ethX
+.I devname
.HP
.B ethtool \-h|\-\-help
.HP
.B ethtool \-\-version
.HP
.B ethtool \-a|\-\-show\-pause
-.I ethX
+.I devname
.HP
.B ethtool \-A|\-\-pause
-.I ethX
+.I devname
.B2 autoneg on off
.B2 rx on off
.B2 tx on off
.HP
.B ethtool \-c|\-\-show\-coalesce
-.I ethX
+.I devname
.HP
.B ethtool \-C|\-\-coalesce
-.I ethX
+.I devname
.B2 adaptive\-rx on off
.B2 adaptive\-tx on off
.BN rx\-usecs
@@ -167,43 +167,43 @@ ethtool \- query or control network driver and hardware settings
.BN sample\-interval
.HP
.B ethtool \-g|\-\-show\-ring
-.I ethX
+.I devname
.HP
.B ethtool \-G|\-\-set\-ring
-.I ethX
+.I devname
.BN rx
.BN rx\-mini
.BN rx\-jumbo
.BN tx
.HP
.B ethtool \-i|\-\-driver
-.I ethX
+.I devname
.HP
.B ethtool \-d|\-\-register\-dump
-.I ethX
+.I devname
.B2 raw on off
.B2 hex on off
.RB [ file
.IR name ]
.HP
.B ethtool \-e|\-\-eeprom\-dump
-.I ethX
+.I devname
.B2 raw on off
.BN offset
.BN length
.HP
.B ethtool \-E|\-\-change\-eeprom
-.I ethX
+.I devname
.BN magic
.BN offset
.BN length
.BN value
.HP
.B ethtool \-k|\-\-show\-offload
-.I ethX
+.I devname
.HP
.B ethtool \-K|\-\-offload
-.I ethX
+.I devname
.B2 rx on off
.B2 tx on off
.B2 sg on off
@@ -217,24 +217,24 @@ ethtool \- query or control network driver and hardware settings
.B2 rxhash on off
.HP
.B ethtool \-p|\-\-identify
-.I ethX
+.I devname
.RI [ N ]
.HP
.B ethtool \-P|\-\-show\-permaddr
-.I ethX
+.I devname
.HP
.B ethtool \-r|\-\-negotiate
-.I ethX
+.I devname
.HP
.B ethtool \-S|\-\-statistics
-.I ethX
+.I devname
.HP
.B ethtool \-t|\-\-test
-.I ethX
+.I devname
.RI [\*(SD]
.HP
.B ethtool \-s
-.I ethX
+.I devname
.BI speed \ N
.B2 duplex half full
.B4 port tp aui bnc mii fibre
@@ -251,27 +251,27 @@ ethtool \- query or control network driver and hardware settings
.RB ...]
.HP
.B ethtool \-n
-.I ethX
+.I devname
.RB [ rx\-flow\-hash \ \*(FL]
.HP
.B ethtool \-N
-.I ethX
+.I devname
.RB [ rx\-flow\-hash \ \*(FL \ \*(HO]
.HP
.B ethtool \-w|\-\-get\-dump
-.I ethX
+.I devname
.RB [ data
.IR filename ]
.HP
.B ethtool\ \-W|\-\-set\-dump
-.I ethX
+.I devname
.BI \ N
.HP
.B ethtool \-x|\-\-show\-rxfh\-indir
-.I ethX
+.I devname
.HP
.B ethtool \-X|\-\-set\-rxfh\-indir
-.I ethX
+.I devname
.RB [\ equal
.IR N \ |
.BI weight\ W0
@@ -279,15 +279,15 @@ ethtool \- query or control network driver and hardware settings
.RB ...\ ]
.HP
.B ethtool \-f|\-\-flash
-.I ethX
+.I devname
.RI FILE
.RI [ N ]
.HP
.B ethtool \-u|\-\-show\-ntuple
-.I ethX
+.I devname
.BN rule
.HP
-.BI ethtool\ \-U|\-\-config\-ntuple \ ethX
+.BI ethtool\ \-U|\-\-config\-ntuple \ devname
.BN delete
.RB [\ flow\-type \ \*(NC
.RB [ src \ \*(MA\ [ m \ \*(MA]]
@@ -309,10 +309,10 @@ ethtool \- query or control network driver and hardware settings
.RB ]
.HP
.B ethtool \-l|\-\-show\-channels
-.I ethX
+.I devname
.HP
.B ethtool \-L|\-\-set\-channels
-.I ethX
+.I devname
.BN rx
.BN tx
.BN other
@@ -327,7 +327,7 @@ ethtool \- query or control network driver and hardware settings
is used to query and control network device driver and hardware
settings, particularly for wired Ethernet devices.
-.I ethX
+.I devname
is the name of the network device on which ethtool should operate.
.SH OPTIONS
--
1.7.4.4
--
Ben Hutchings, Staff Engineer, Solarflare
Not speaking for my employer; that's the marketing department's job.
They asked us to note that Solarflare product names are trademarked.
next prev parent reply other threads:[~2011-11-01 23:15 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-11-01 22:35 [PATCH ethtool 00/21] ethtool refactoring and misc changes Ben Hutchings
2011-11-01 23:13 ` [PATCH ethtool 01/21] Report pause frame autonegotiation result Ben Hutchings
2011-11-01 23:13 ` [PATCH ethtool 02/21] ethtool.8: Fix initial blank line/page Ben Hutchings
2011-11-01 23:14 ` [PATCH ethtool 03/21] Combine ethtool-{bitops,util}.h into internal.h Ben Hutchings
2011-11-01 23:14 ` [PATCH ethtool 04/21] Fix type of bit-number parameter to set_bit() and clear_bit() Ben Hutchings
2011-11-01 23:15 ` Ben Hutchings [this message]
2011-11-01 23:15 ` [PATCH ethtool 06/21] ethtool.8: Allow line-break in description of parameters after -N Ben Hutchings
2011-11-01 23:15 ` [PATCH ethtool 07/21] Fix format of help text for -f option Ben Hutchings
2011-11-01 23:15 ` [PATCH ethtool 08/21] Use standard indentation for definition of struct option args Ben Hutchings
2011-11-01 23:16 ` [PATCH ethtool 09/21] Encapsulate command context in a structure Ben Hutchings
2011-11-01 23:17 ` [PATCH ethtool 10/21] Add test cases for command-line parsing Ben Hutchings
2011-11-01 23:17 ` [PATCH ethtool 11/21] Add more " Ben Hutchings
2011-11-01 23:18 ` [PATCH ethtool 12/21] Move argument parsing to sub-command functions Ben Hutchings
2011-11-01 23:18 ` [PATCH ethtool 13/21] Support arbitrary numbers of option names for each mode Ben Hutchings
2011-11-01 23:18 ` [PATCH ethtool 14/21] Fix reference to cmdline_ring in do_schannels() Ben Hutchings
2011-11-01 23:19 ` [PATCH ethtool 15/21] Convert cmdline_msglvl into array of named flags; convert back at run-time Ben Hutchings
2011-11-01 23:20 ` [PATCH ethtool 16/21] Replace global devname variable with a field in struct cmd_context Ben Hutchings
2011-11-01 23:21 ` [PATCH ethtool 17/21] Change most static global variables into automatic variables Ben Hutchings
2011-11-01 23:22 ` [PATCH ethtool 18/21] rxclass: Replace global rmgr with automatic variable/parameter Ben Hutchings
2011-11-01 23:22 ` [PATCH ethtool 19/21] Declare static variables const as appropriate Ben Hutchings
2011-11-01 23:23 ` [PATCH ethtool 20/21] Run tests in-process Ben Hutchings
2011-11-02 20:25 ` Ben Hutchings
2011-11-01 23:24 ` [PATCH ethtool 21/21] Rearrange definitions and remove unnecessary forward declarations Ben Hutchings
2011-11-03 19:17 ` [PATCH ethtool 00/21] ethtool refactoring and misc changes Ben Hutchings
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1320189302.2758.35.camel@bwh-desktop \
--to=bhutchings@solarflare.com \
--cc=linux-net-drivers@solarflare.com \
--cc=netdev@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.