Wordsmith mlx4{en,ib}(4)

- Replace the "following lines" with more terse phrases.
- Use .Lk for the mellanox URL.
- Reword the SUPPORT section so it's less wordy.

The DESCRIPTION section suggestions are still outstanding; improving
the section requires additional review to make sure the nuance/message
is correct per the original intent.

Bump .Dd for the change

Submitted by:	wblock
Sponsored by:	Dell EMC Isilon
Differential Revision:	https://reviews.freebsd.org/D9241
This commit is contained in:
Enji Cooper 2017-03-02 06:57:13 +00:00
parent c907245759
commit e51c23d9fb
2 changed files with 14 additions and 16 deletions

View File

@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd January 18, 2017
.Dd March 1, 2017
.Dt MLX4EN 4
.Os
.Sh NAME
@ -32,8 +32,7 @@
.Nd "Mellanox ConnectX-3 10GbE/40GbE network adapter driver"
.Sh SYNOPSIS
To compile this driver into the kernel,
place the following lines in your
kernel configuration file:
place these lines in your kernel configuration file:
.Bd -ragged -offset indent
.Cd "options COMPAT_LINUXKPI"
.Cd "device mlx4"
@ -41,13 +40,13 @@ kernel configuration file:
.Ed
.Pp
To load the driver as a module at run-time,
run the following command as root:
run this command as root:
.Bd -literal -offset indent
kldload mlx4en
.Ed
.Pp
To load the driver as a
module at boot time, place the following lines in
module at boot time, place this line in
.Xr loader.conf 5 :
.Bd -literal -offset indent
mlx4en_load="YES"
@ -75,10 +74,10 @@ Mellanox ConnectX-3 (ETH)
.Sh SUPPORT
For general information and support,
go to the Mellanox support website at:
.Pa http://www.mellanox.com/ .
.Lk http://www.mellanox.com/ .
.Pp
If an issue is identified with this driver with a supported adapter,
email all the specific information related to the issue to
If an issue is identified with this driver and a supported network adapter,
please email the specific information to
.Aq Mt freebsd-drivers@mellanox.com .
.Sh SEE ALSO
.Xr mlx4ib 4 ,

View File

@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd January 18, 2017
.Dd March 1, 2017
.Dt MLX4IB 4
.Os
.Sh NAME
@ -32,8 +32,7 @@
.Nd "Mellanox ConnectX-3 10GbE/40GbE network adapter driver"
.Sh SYNOPSIS
To compile this driver into the kernel,
place the following lines in your
kernel configuration file:
place these lines in your kernel configuration file:
.Bd -ragged -offset indent
.Cd "options COMPAT_LINUXKPI"
.Cd "device mlx4"
@ -41,13 +40,13 @@ kernel configuration file:
.Ed
.Pp
To load the driver as a module at run-time,
run the following command as root:
run this command as root:
.Bd -literal -offset indent
kldload mlx4ib
.Ed
.Pp
To load the driver as a
module at boot time, place the following lines in
module at boot time, place this line in
.Xr loader.conf 5 :
.Bd -literal -offset indent
mlx4ib_load="YES"
@ -75,10 +74,10 @@ Mellanox ConnectX-3 (IB)
.Sh SUPPORT
For general information and support,
go to the Mellanox support website at:
.Pa http://www.mellanox.com/ .
.Lk http://www.mellanox.com/ .
.Pp
If an issue is identified with this driver with a supported adapter,
email all the specific information related to the issue to
If an issue is identified with this driver and a supported network adapter,
please email the specific information to
.Aq Mt freebsd-drivers@mellanox.com .
.Sh SEE ALSO
.Xr mlx4en 4 ,