From owner-freebsd-doc@FreeBSD.ORG Mon Jul 11 18:30:09 2011 Return-Path: Delivered-To: freebsd-doc@hub.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id 43F4F1065673 for ; Mon, 11 Jul 2011 18:30:09 +0000 (UTC) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (freefall.freebsd.org [IPv6:2001:4f8:fff6::28]) by mx1.freebsd.org (Postfix) with ESMTP id 1BB2C8FC17 for ; Mon, 11 Jul 2011 18:30:09 +0000 (UTC) Received: from freefall.freebsd.org (localhost [127.0.0.1]) by freefall.freebsd.org (8.14.4/8.14.4) with ESMTP id p6BIU8Wv087690 for ; Mon, 11 Jul 2011 18:30:08 GMT (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.14.4/8.14.4/Submit) id p6BIU8GX087685; Mon, 11 Jul 2011 18:30:08 GMT (envelope-from gnats) Resent-Date: Mon, 11 Jul 2011 18:30:08 GMT Resent-Message-Id: <201107111830.p6BIU8GX087685@freefall.freebsd.org> Resent-From: FreeBSD-gnats-submit@FreeBSD.org (GNATS Filer) Resent-To: freebsd-doc@FreeBSD.org Resent-Reply-To: FreeBSD-gnats-submit@FreeBSD.org, Ben Kaduk Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id 0CC3D1065670 for ; Mon, 11 Jul 2011 18:25:42 +0000 (UTC) (envelope-from nobody@FreeBSD.org) Received: from red.freebsd.org (red.freebsd.org [IPv6:2001:4f8:fff6::22]) by mx1.freebsd.org (Postfix) with ESMTP id E687B8FC12 for ; Mon, 11 Jul 2011 18:25:41 +0000 (UTC) Received: from red.freebsd.org (localhost [127.0.0.1]) by red.freebsd.org (8.14.4/8.14.4) with ESMTP id p6BIPf9w084121 for ; Mon, 11 Jul 2011 18:25:41 GMT (envelope-from nobody@red.freebsd.org) Received: (from nobody@localhost) by red.freebsd.org (8.14.4/8.14.4/Submit) id p6BIPfKc084120; Mon, 11 Jul 2011 18:25:41 GMT (envelope-from nobody) Message-Id: <201107111825.p6BIPfKc084120@red.freebsd.org> Date: Mon, 11 Jul 2011 18:25:41 GMT From: Ben Kaduk To: freebsd-gnats-submit@FreeBSD.org X-Send-Pr-Version: www-3.1 Cc: Subject: docs/158813: grammar updates for jme.4 X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 11 Jul 2011 18:30:09 -0000 >Number: 158813 >Category: docs >Synopsis: grammar updates for jme.4 >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: doc-bug >Submitter-Id: current-users >Arrival-Date: Mon Jul 11 18:30:08 UTC 2011 >Closed-Date: >Last-Modified: >Originator: Ben Kaduk >Release: 9-current >Organization: MIT SIPB >Environment: n/a >Description: Mostly just sprinkling the definite article in places, but also make the style of sysctl/tunable variable descriptions match the style of the pure tunable descriptions. >How-To-Repeat: >Fix: Patch attached with submission follows: --- jme.4.orig 2011-07-11 13:03:17.000000000 -0400 +++ jme.4 2011-07-11 14:14:41.000000000 -0400 @@ -24,7 +24,7 @@ .\" .\" $FreeBSD: src/share/man/man4/jme.4,v 1.5 2011/06/29 17:32:52 yongari Exp $ .\" -.Dd June 29, 2011 +.Dd July 11, 2011 .Dt JME 4 .Os .Sh NAME @@ -130,23 +130,27 @@ tunables: .Bl -tag -width "xxxxxx" .It Va dev.jme.%d.tx_coal_to -Maximum amount of time to delay for Tx completion interrupt in -units of 1us. -The accepted range is 1 to 65535, the default is 100 (100us). +This variable sets the +maximum amount of time to delay before sending a Tx completion interrupt, in +microseconds. +The accepted range is 1 to 65535; the default is 100 (100us). .It Va dev.jme.%d.tx_coal_pkt -Maximum number of packets to fire Tx completion interrupt. -The accepted range is 1 to 255, the default is 8. +This variable sets the maximum number of outgoing packets which may be +coalesced together into a single Tx completion interrupt. +The accepted range is 1 to 255; the default is 8. .It Va dev.jme.%d.rx_coal_to -Maximum amount of time to delay for Rx completion interrupt in -units of 1us. -The accepted range is 1 to 65535, the default is 100 (100us). +This variable sets the maximum amount of time to wait for +additional packets to arrive (for possible packet coalescing) +before firing an Rx completion interrupt, in microseconds. +The accepted range is 1 to 65535; the default is 100 (100us). .It Va dev.jme.%d.rx_coal_pkt -Maximum number of packets to fire Rx completion interrupt. -The accepted range is 1 to 255, the default is 2. +This variable sets the maximum number of incoming packets which may be +coalesced into a single Rx completion interrupt. +The accepted range is 1 to 255; the default is 2. .It Va dev.jme.%d.process_limit -Maximum amount of Rx events to be processed in the event loop before -rescheduling a taskqueue. -The accepted range is 10 to 255, the default value is 128 events. +This variable sets the maximum number of events that will be processed +in a single batch before the handler is requeued into a taskqueue. +The accepted range is 10 to 255; the default value is 128 events. The interface does not need to be brought down and up again before a change takes effect. .El @@ -173,22 +177,23 @@ controllers that use eFuse to store station address. The number of times that eFuse can be safely reprogrammed is 16 at most. -In addition, there is no way to restore factory default station -address once station address is reprogrammed via eFuse. -It is highly recommended not to reprogram station address and -it is responsibility of administrator to store original station -address into a safe place when station address should be changed. +In addition, there is no way to restore the factory default station +address once the station address has been reprogrammed via eFuse. +It is highly recommended not to reprogram the station address and +it is the responsibility of the administrator to store the original station +address in a safe place when station address is changed. .Pp There are two known 1000baseT link establishment issues with JMC25x. If the full mask revision number of JMC25x controller is less than -or equal to 4 and link partner enabled IEEE 802.3az Energy Efficient -Ethernet feature, the controller would not be able to establish a +or equal to 4 and the link partner enabled the IEEE 802.3az Energy Efficient +Ethernet feature, the controller will not be able to establish a 1000baseT link. -Also if the length of cable is longer than 120 meters, controller +Also, if the length of the cable is longer than 120 meters, the controller can not establish a 1000baseT link. -The known workaround for the issue is to force manual link +The known workaround for these issues is to force manual link configuration with 100baseTX instead of relying on auto-negotiation. -The full mask revision number of controller could be checked with +The full mask revision number of controller can be checked with the verbose kernel boot option. -Use lower nibble of chip revision number to get full mask revision of +Use the lower nibble of the chip revision number to get the +full mask revision of the controller. >Release-Note: >Audit-Trail: >Unformatted: