Re: [PATCH 2/2] Ethtool: add EEE to ethtool's documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

On Tue, 2012-06-05 at 09:41 +0300, Yuval Mintz wrote:
> under Synopsis:
> 	ethtool --get-eee devname
> 	ethtool --set-eee devname [eee on|off] [tx-lpi on|off] [tx-timer N] [advertise N]
> 
> under Options:
>        --get-eee
>               Queries  the  specified network device for its support in Efficient Energy Ethernet (ac-
> 	      cording to the IEEE 802.3az specifications)
>        --set-eee
> 	      Sets the device EEE behaviour.
>        eee on|off
> 	      Enables/Disables the device support in EEE.
>        tx-lpi on|off
> 	      Determines whether the device should assert its tx lpi.
>        advertise N
>               Sets the speeds for which the device would advertise EEE capabliities.   Values  are  as
> 	      for --change advertise
>        tx-timer N
>               Sets  the  amount  of time the device should stay in idle mode prior to asserting its tx
>               lpi (in microseconds). This has meaning only when tx lpi is on.

Please just fold this change into the patch that adds the options.  Also
there is no need to repeat the content in the commit message.

> Signed-off-by: Yuval Mintz <yuvalmin@xxxxxxxxxxxx>
> Signed-off-by: Eilon Greenstein <eilong@xxxxxxxxxxxx>
> ---
>  ethtool.8.in |   32 ++++++++++++++++++++++++++++++++
>  1 files changed, 32 insertions(+), 0 deletions(-)
> 
> diff --git a/ethtool.8.in b/ethtool.8.in
> index 523b737..b906d8e 100644
> --- a/ethtool.8.in
> +++ b/ethtool.8.in
> @@ -335,6 +335,16 @@ ethtool \- query or control network driver and hardware settings
>  .I devname flag
>  .A1 on off
>  .RB ...
> +.HP
> +.B ethtool \-\-get\-eee
> +.I devname
> +.HP
> +.B ethtool \-\-set\-eee
> +.I devname
> +.B2 eee on off
> +.B2 tx-lpi on off
> +.BN tx-timer
> +.BN advertise
>  .
>  .\" Adjust lines (i.e. full justification) and hyphenate.
>  .ad
> @@ -817,6 +827,28 @@ Sets the device's private flags as specified.
>  .I flag
>  .A1 on off
>  Sets the state of the named private flag.
> +.TP
> +.B \-\-get\-eee
> +Queries the specified network device for its support in Efficient Energy
> +Ethernet (according to the IEEE 802.3az specifications)

'of', not 'in'

> +.TP
> +.B \-\-set\-eee
> +Sets the device EEE behaviour.
> +.TP
> +.A2 eee on off
> +Enables/Disables the device support in EEE.

Lower-case 'd' for 'disables'.
'of', not 'in'

> +.TP
> +.A2 tx-lpi on off
> +Determines whether the device should assert its tx lpi.

'TX LPI' should be in upper-case.

> +.TP
> +.BI advertise \ N
> +Sets the speeds for which the device would advertise EEE capabliities.

'would', not 'should'
'capabilities', not 'capabliities'

> +Values are as for
> +.B \-\-change advertise
> +.TP
> +.BI tx-timer \ N
> +Sets the amount of time the device should stay in idle mode prior to asserting
> +its tx lpi (in microseconds). This has meaning only when tx lpi is on.

Same here.

Ben.

>  .SH BUGS
>  Not supported (in part or whole) on all network drivers.
>  .SH AUTHOR

-- 
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.

--
To unsubscribe from this list: send the line "unsubscribe netdev" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[Linux Kernel Discussion]     [Ethernet Bridging]     [Linux Wireless Networking]     [Linux Bluetooth Networking]     [Linux Networking Users]     [VLAN]     [Git]     [IETF Annouce]     [Linux Assembly]     [Security]     [Bugtraq]     [Photo]     [Singles Social Networking]     [Yosemite Information]     [MIPS Linux]     [ARM Linux Kernel]     [ARM Linux]     [Linux Virtualization]     [Linux Security]     [Linux IDE]     [Linux RAID]     [Linux SCSI]     [Free Dating]

Add to Google Powered by Linux