Skip site navigation (1)Skip section navigation (2)
Date:      Thu, 2 Mar 2017 06:57:13 +0000 (UTC)
From:      Ngie Cooper <ngie@FreeBSD.org>
To:        src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org
Subject:   svn commit: r314546 - head/share/man/man4
Message-ID:  <201703020657.v226vDij045640@repo.freebsd.org>

next in thread | raw e-mail | index | archive | help
Author: ngie
Date: Thu Mar  2 06:57:13 2017
New Revision: 314546
URL: https://svnweb.freebsd.org/changeset/base/314546

Log:
  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

Modified:
  head/share/man/man4/mlx4en.4
  head/share/man/man4/mlx4ib.4

Modified: head/share/man/man4/mlx4en.4
==============================================================================
--- head/share/man/man4/mlx4en.4	Thu Mar  2 06:25:50 2017	(r314545)
+++ head/share/man/man4/mlx4en.4	Thu Mar  2 06:57:13 2017	(r314546)
@@ -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 ,

Modified: head/share/man/man4/mlx4ib.4
==============================================================================
--- head/share/man/man4/mlx4ib.4	Thu Mar  2 06:25:50 2017	(r314545)
+++ head/share/man/man4/mlx4ib.4	Thu Mar  2 06:57:13 2017	(r314546)
@@ -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 ,



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201703020657.v226vDij045640>