From owner-freebsd-doc@FreeBSD.ORG Sun Oct 9 20:10:19 2005 Return-Path: X-Original-To: freebsd-doc@hub.freebsd.org Delivered-To: freebsd-doc@hub.freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 2666B16A420 for ; Sun, 9 Oct 2005 20:10:19 +0000 (GMT) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (freefall.freebsd.org [216.136.204.21]) by mx1.FreeBSD.org (Postfix) with ESMTP id 6208D43D46 for ; Sun, 9 Oct 2005 20:10:18 +0000 (GMT) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (gnats@localhost [127.0.0.1]) by freefall.freebsd.org (8.13.3/8.13.3) with ESMTP id j99KAIAI013734 for ; Sun, 9 Oct 2005 20:10:18 GMT (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.13.3/8.13.1/Submit) id j99KAIHV013733; Sun, 9 Oct 2005 20:10:18 GMT (envelope-from gnats) Resent-Date: Sun, 9 Oct 2005 20:10:18 GMT Resent-Message-Id: <200510092010.j99KAIHV013733@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, "Devon H. O'Dell" Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id C416816A41F for ; Sun, 9 Oct 2005 20:05:25 +0000 (GMT) (envelope-from dodell@skik.dtrace.internal.sitetronics.com) Received: from knight.ixsystems.net (afg.ixsystems.net [206.40.55.73]) by mx1.FreeBSD.org (Postfix) with ESMTP id 637E543D73 for ; Sun, 9 Oct 2005 20:05:21 +0000 (GMT) (envelope-from dodell@skik.dtrace.internal.sitetronics.com) Received: from skik.dtrace.internal.sitetronics.com (afg.ixsystems.net [206.40.55.73]) by knight.ixsystems.net (8.12.10/8.11.6) with ESMTP id j99JXeCI057364 for ; Sun, 9 Oct 2005 12:33:44 -0700 (PDT) (envelope-from dodell@skik.dtrace.internal.sitetronics.com) Received: from skik.dtrace.internal.sitetronics.com (localhost [127.0.0.1]) by skik.dtrace.internal.sitetronics.com (8.13.5/8.13.4) with ESMTP id j99K5afX036751 for ; Sun, 9 Oct 2005 13:05:36 -0700 (PDT) (envelope-from dodell@skik.dtrace.internal.sitetronics.com) Received: (from dodell@localhost) by skik.dtrace.internal.sitetronics.com (8.13.5/8.13.4/Submit) id j99K5a3J036750; Sun, 9 Oct 2005 13:05:36 -0700 (PDT) (envelope-from dodell) Message-Id: <200510092005.j99K5a3J036750@skik.dtrace.internal.sitetronics.com> Date: Sun, 9 Oct 2005 13:05:36 -0700 (PDT) From: "Devon H. O'Dell" To: FreeBSD-gnats-submit@FreeBSD.org X-Send-Pr-Version: 3.113 Cc: Subject: docs/87176: X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list Reply-To: "Devon H. O'Dell" List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 09 Oct 2005 20:10:19 -0000 >Number: 87176 >Category: docs >Synopsis: >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: Sun Oct 09 20:10:17 GMT 2005 >Closed-Date: >Last-Modified: >Originator: Devon H. O'Dell >Release: FreeBSD 7.0-CURRENT amd64 >Organization: OffMyServer, Inc. >Environment: System: FreeBSD skik.dtrace.internal.sitetronics.com 7.0-CURRENT FreeBSD 7.0-CURRENT #0: Tue Oct 4 13:44:46 PDT 2005 dodell@skik.dtrace.internal.sitetronics.com:/usr/obj/usr/src/sys/SKIK-RD amd64 >Description: The device_get_softc(9) manpage incorrectly or ambiguously specifies when allocation of the device's softc takes place. My interpretation was that it takes place on the call of device_get_softc(9). To the contrary, the implementation of device_get_softc simply returns the dev->softc field; allocation is automatically done when the device attaches. >How-To-Repeat: man 9 device_get_softc >Fix: --- device_get_softc.9.patch begins here --- --- share/man/man9/device_get_softc.9.old Sun Oct 9 12:57:20 2005 +++ share/man/man9/device_get_softc.9 Sun Oct 9 12:58:05 2005 @@ -42,8 +42,8 @@ .Sh DESCRIPTION Return the driver-specific state of .Fa dev . -The softc is automatically allocated and zeroed the first -time it is requested. +The softc is automatically allocated and zeroed when the +driver is attached. The size of the allocation is determined by the device's .Vt driver_t information used to define the driver. --- device_get_softc.9.patch ends here --- >Release-Note: >Audit-Trail: >Unformatted: [patch] device_get_softc(9) is ambiguous about when allocation takes place