linux-kernel - Re: [PATCH 1/2] igb.txt: Add igb documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <AANLkTimTqMb+n9-v9PDeY2ByN3n2BD_eQfmxJ8ymyuyZ@mail.gmail.com>
Date:	Wed, 4 Aug 2010 21:20:36 -0700
From:	Jeff Kirsher <jeffrey.t.kirsher@...el.com>
To:	Ben Hutchings <bhutchings@...arflare.com>
Cc:	davem@...emloft.net, netdev@...r.kernel.org,
	linux-kernel@...r.kernel.org, gospo@...hat.com, bphilips@...ell.com
Subject: Re: [PATCH 1/2] igb.txt: Add igb documentation

0On Tue, Aug 3, 2010 at 19:34, Ben Hutchings <bhutchings@...arflare.com> wrote:
> On Tue, 2010-08-03 at 17:15 -0700, Jeff Kirsher wrote:
> [...]
>> +  Jumbo Frames
>> +  ------------
>> +  Jumbo Frames support is enabled by changing the MTU to a value larger than
>> +  the default of 1500.  Use the ifconfig command to increase the MTU size.
>> +  For example:
>> +
>> +       ifconfig eth<x> mtu 9000 up
>> +
>> +  This setting is not saved across reboots.
>
> Not igb-specific.
>
> [...]
>> +  Ethtool
>> +  -------
>> +  The driver utilizes the ethtool interface for driver configuration and
>> +  diagnostics, as well as displaying statistical information.  Ethtool
>> +  version 3.0 or later is required for this functionality, although we
>> +  strongly recommend downloading the latest version at:
>> +
>> +  http://sourceforge.net/projects/gkernel.
>
> Not igb-specific, and seriously - 3.0?
>
>> +  Enabling Wake on LAN* (WoL)
>> +  ---------------------------
>> +  WoL is configured through the Ethtool* utility.
>
> Not igb-specific.
>
> [...]
>> +  LRO
>> +  ---
>> +  Large Receive Offload (LRO) is a technique for increasing inbound throughput
>> +  of high-bandwidth network connections by reducing CPU overhead. It works by
>> +  aggregating multiple incoming packets from a single stream into a larger
>> +  buffer before they are passed higher up the networking stack, thus reducing
>> +  the number of packets that have to be processed. LRO combines multiple
>> +  Ethernet frames into a single receive in the stack, thereby potentially
>> +  decreasing CPU utilization for receives.
>
> Not igb-specific.
>
>> +  NOTE: LRO requires 2.6.24 or later kernel version.
> [...]
>
> Which is irrelevant to an in-tree driver.
>
> Ben.
>
> --
> Ben Hutchings, Senior Software Engineer, Solarflare Communications
> Not speaking for my employer; that's the marketing department's job.
> They asked us to note that Solarflare product names are trademarked.
>

Thanks for the review Ben.

I am fine and agree with removing the reference to Ethtool version 3.0
and reference to LRO requiring 2.6.24 kernel.  Sorry we did not catch
the earlier...

As far as the 4 sections you noted as not being igb-specific, while
these sections are not specific to the driver, I see them as useful to
users trying to find more information on the driver and how to
configure it.  IMHO more documentation is more useful that too little,
as long as you are not adding bloat to the documentation which makes
it difficult to find what you are looking for.

If I am in minority here, I fine with removing the non-igb specific
sections as well.

-- 
Cheers,
Jeff
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/