ix(4): Document E610 hardware and debug dump feature

[Yogesh.Bhosale_intel.com]

Summary

This update adds Intel E610 Ethernet Controller devices to the ix(4) manual
page hardware list and documents the debug dump feature.

Hardware section changes:

• Add E610 family devices to the supported hardware list

Debug dump documentation:

• Explains how to use sysctl commands to collect device data for troubleshooting
• Lists the available options for selecting data clusters
• Notes that the output is not readable without help from Customer Support
• Feature is specific to E610 devices

Signed-off-by: Yogesh Bhosale [e-mail]

[ziaee]

Thanks for this! Wow cool, 2x10G @ 5w!

share/man/man4/ix.4

79–98

Keep this list sorted reverse chronologically.

135

Roff shouldn't have blank lines (check the linter with mandoc -Tlint share/man/man4/ix.4), if you really want to do this, you can use an empty comment with .\". Ditto for the others.

169–172

We want sysctl nodes to be marked up with Va that way people can search the manual for them, e.g. apropos Va=debug.dump.clusters. Ditto for the others.

[erj]

(approval for the functionality; you should make @ziaee's suggested changes to the documentation)

[bcr]

Thanks for the documentation. I made some suggestion on language improvements.

share/man/man4/ix.4

139

We try to avoid the use of "you" in the documentation.
You can rephrase the sentence like this:

Intel(R) E610 Ethernet Controller devices support debug dump, which allows obtaining runtime register ...

152

Rephrase to avoi "you" in here like this (suggestions):

"Work with customer support ..."

or

"Contact customer support ..."

209

Avoiding "you":
When a cluster is not specified, the driver will ...

222

Avoiding "you":
Setting the sysctl to 1 will make the driver not receive the command.

226

... with the desired file name.

228

Avoiding "you":
If no clusters were specified, the dump file will ...

[Yogesh.Bhosale_intel.com]

ix(4): Document E610 hardware and debug dump feature

This update adds Intel E610 Ethernet Controller devices to the ix(4) manual
page hardware list and documents the debug dump feature.

Hardware section changes:

Add E610 family devices to the supported hardware list
Debug dump documentation:

Explains how to use sysctl commands to collect device data for troubleshooting
Lists the available options for selecting data clusters
Notes that the output is not readable without help from Customer Support
Feature is specific to E610 devices
Signed-off-by: Yogesh Bhosale [e-mail]

[Yogesh.Bhosale_intel.com]

ix(4): Document E610 hardware and debug dump feature

This update adds Intel E610 Ethernet Controller devices to the ix(4) manual
page hardware list and documents the debug dump feature.

Hardware section changes:

Add E610 family devices to the supported hardware list
Debug dump documentation:

Explains how to use sysctl commands to collect device data for troubleshooting
Lists the available options for selecting data clusters
Notes that the output is not readable without help from Customer Support
Feature is specific to E610 devices
Signed-off-by: Yogesh Bhosale [e-mail]

[Yogesh.Bhosale_intel.com]

@ziaee @bcr

Thanks for reviewing the changes. I have addressed your comments.

[Yogesh.Bhosale_intel.com]

My last commit accidentally picked up a lot of files. Please ignore it. I have fixed this in the current one.

[kgalazka]

Fix reviewers list.

[Yogesh.Bhosale_intel.com]

@ziaee @bcr
I have addressed your review comments. I would appreciate it if you could take another look and approve if it looks good.