svn commit: r310626 - stable/11/share/man/man4

[Julian Elischer]

Author: julian
Date: Tue Dec 27 08:32:54 2016
New Revision: 310626
URL: https://svnweb.freebsd.org/changeset/base/310626

Log:
  MFH: r309407
  
  A little light wordsmithing only.
  
  Sponsored by:	FreeBSD

Modified:
  stable/11/share/man/man4/ng_checksum.4
Directory Properties:
  stable/11/   (props changed)

Modified: stable/11/share/man/man4/ng_checksum.4
==============================================================================
--- stable/11/share/man/man4/ng_checksum.4	Tue Dec 27 08:31:40 2016	(r310625)
+++ stable/11/share/man/man4/ng_checksum.4	Tue Dec 27 08:32:54 2016	(r310626)
@@ -29,26 +29,26 @@
 .Os
 .Sh NAME
 .Nm ng_checksum
-.Nd IP checksum node type
+.Nd reconstructing IP checksums node type
 .Sh SYNOPSIS
 .In netgraph/ng_checksum.h
 .Sh DESCRIPTION
 The
 .Nm checksum
-node can calculate and prepare for calculation in hardware
-IPv4 header, TCP, UDP checksum.
+node can calculate, or prepare for calculation in hardware,
+IPv4 header, TCP and UDP checksums.
 .Sh HOOKS
 This node type has two hooks:
 .Bl -tag -width ".Va out"
 .It Va in
 Packets received on this hook are processed according to settings specified
-in config and then forwarded to
+in config and then forwarded to the
 .Ar out
-hook, if it exists and connected. Otherwise they are reflected back to the
+hook, if it exists and is connected. Otherwise they are reflected back to the
 .Ar in
 hook.
 .It Va out
-Packets received on this hook are forwarded to
+Packets received on this hook are forwarded to the
 .Ar in
 hook without any changes.
 .El
@@ -56,13 +56,13 @@ hook without any changes.
 This node type supports the generic control messages, plus the following:
 .Bl -tag -width foo
 .It Dv NGM_CHECKSUM_SETDLT Pq Ic setdlt
-Sets data link type on the
+Sets the data link type on the
 .Va in
 hook. Currently, supported types are
 .Cm DLT_RAW
 (raw IP datagrams) and
 .Cm DLT_EN10MB
-(Ethernet). DLT_ definitions can be found in
+(Ethernet). DLT_ definitions can be found in the
 .In net/bpf.h
 header. Currently used values are
 .Cm DLT_EN10MB
@@ -70,11 +70,11 @@ header. Currently used values are
 .Cm DLT_RAW
 = 12.
 .It Dv NGM_CHECKSUM_GETDLT Pq Ic getdlt
-This control message obtains data link type on the
+This control message obtains the data link type on the
 .Va in
 hook.
 .It Dv NGM_CHECKSUM_SETCONFIG Pq Ic setconfig
-Sets node configuration. The following
+Sets the node configuration. The following
 .Vt "struct ng_checksum_config"
 must be supplied as an argument:
 .Bd -literal -offset 4n
@@ -87,23 +87,24 @@ struct ng_checksum_config {
 The
 .Va csum_flags
 can be set to any combination of CSUM_IP, CSUM_TCP, CSUM_UDP, CSUM_TCP_IPV6 and CSUM_UDP_IPV6
-(other values are ignored) for instructing node need calculate the corresponding checksum.
+(other values are ignored) for instructing the node to calculate the corresponding checksum.
 .Pp
 The
 .Va csum_offload
-can be set to any combination of CSUM_IP, CSUM_TCP, CSUM_UDP, CSUM_TCP_IPV6 and CSUM_UDP_IPV6
-(other values are ignored) for instructing node what checksum can calculate in hardware.
+value can be set to any combination of CSUM_IP, CSUM_TCP, CSUM_UDP, CSUM_TCP_IPV6 and CSUM_UDP_IPV6
+(other values are ignored) for instructing the node what checksums should be requested from the hardware.
 .Pp
-Also processed any combination of CSUM_IP, CSUM_TCP, CSUM_UDP, CSUM_TCP_IPV6 and CSUM_UDP_IPV6 sets before on mbuf.
+The node also takes into account any combination of
+CSUM_IP, CSUM_TCP, CSUM_UDP, CSUM_TCP_IPV6 and CSUM_UDP_IPV6 already
+flagged on the mbuf.
 .It Dv NGM_CHECKSUM_GETCONFIG Pq Ic getconfig
-This control message obtains current node configuration,
-returned as
+This control message obtains the current node configuration returned as a
 .Vt "struct ng_checksum_config" .
 .It Dv NGM_CHECKSUM_GET_STATS Pq Ic getstats
 Returns node statistics as a
 .Vt "struct ng_checksum_stats" .
 .It Dv NGM_CHECKSUM_CLR_STATS Pq Ic clrstats
-Clear node statistics.
+Clear the node statistics.
 .It Dv NGM_CHECKSUM_GETCLR_STATS Pq Ic getclrstats
 This command is identical to
 .Dv NGM_CHECKSUM_GET_STATS ,
@@ -118,14 +119,15 @@ control message, or when all hooks have 
 script:
 .Bd -literal -offset 4n
 /usr/sbin/ngctl -f- <<-SEQ
-	msg checksum-1: "setdlt 1"
-	ngctl msg checksum-1: "setconfig { csum_flags=0 csum_offload=6 }"
+	msg checksum-1: setdlt 1
+	msg checksum-1: setconfig { csum_flags=0 csum_offload=6 }
+SEQ
 .Ed
 .Pp
-Set data link type to
+Set the data link type to
 .Cm DLT_EN10MB
-(Ethernet), not set additional checksum flags, set hardware
-can calculate CSUM_IP_UDP|CSUM_IP_TCP.
+(Ethernet), do not set additional checksum flags
+and request that the hardware calculate CSUM_IP_UDP|CSUM_IP_TCP.
 .Sh SEE ALSO
 .Xr netgraph 4 ,
 .Xr ng_patch 4 ,