Subject: Re: [PATCH net-next v2 2/8] net: aquantia: add documentation for the atlantic driver

From: Andrew Lunn <[email-masked]>
Date: Tue, 25 Jun 2019 00:15:54 +0200

On Mon, Jun 24, 2019 at 03:10:47PM +0000, Igor Russkikh wrote:
> Document contains configuration options description,
> details and examples of driver various settings.
> 
> Signed-off-by: Igor Russkikh <[email-masked]>
> ---
>  .../device_drivers/aquantia/atlantic.txt      | 437 ++++++++++++++++++
>  1 file changed, 437 insertions(+)
>  create mode 100644 Documentation/networking/device_drivers/aquantia/atlantic.txt
> 
> diff --git a/Documentation/networking/device_drivers/aquantia/atlantic.txt b/Documentation/networking/device_drivers/aquantia/atlantic.txt
> new file mode 100644
> index 000000000000..45b93f8143b4
> --- /dev/null
> +++ b/Documentation/networking/device_drivers/aquantia/atlantic.txt
> @@ -0,0 +1,437 @@
> +aQuantia AQtion Driver for the aQuantia Multi-Gigabit PCI Express Family of
> +Ethernet Adapters
> +=============================================================================
> +
> +Contents
> +========
> +
> +- Important Note
> +- Identifying Your Adapter
> +- Command Line Parameters
> +- Additional Configurations
> +- Support

Hi Igor

This TOC is now out of date. You don't have an Important Note section,
Command line parameters are near the end etc.

> +
> +Identifying Your Adapter
> +========================
> +
> +The driver in this release is compatible with AQC-100, AQC-107, AQC-108 based ethernet adapters.
> +
> +
> +SFP+ Devices (for AQC-100 based adapters)
> +----------------------------------
> +
> +This release tested with passive Direct Attach Cables (DAC) and SFP+/LC Optical Transceiver.
> +
> +Config file parameters
> +=======================
> +For some fine tuning and performance optimizations,
> +some parameters can be changed in the {source_dir}/aq_cfg.h file.

To me, these seems like the least likely option, so should come last
for those who are very desperate. Start with ethtool, then command
line parameters, and if all else fails, hack the code to change
settings.

	    Andrew