From nobody@FreeBSD.org  Wed Jan 30 10:05:34 2002
Return-Path: <nobody@FreeBSD.org>
Received: from freefall.freebsd.org (freefall.FreeBSD.org [216.136.204.21])
	by hub.freebsd.org (Postfix) with ESMTP id 9776D37B400
	for <freebsd-gnats-submit@FreeBSD.org>; Wed, 30 Jan 2002 10:05:25 -0800 (PST)
Received: (from nobody@localhost)
	by freefall.freebsd.org (8.11.6/8.11.6) id g0UI5PW33657;
	Wed, 30 Jan 2002 10:05:25 -0800 (PST)
	(envelope-from nobody)
Message-Id: <200201301805.g0UI5PW33657@freefall.freebsd.org>
Date: Wed, 30 Jan 2002 10:05:25 -0800 (PST)
From: Bruce Dang <bruce@research.teamxor.org>
To: freebsd-gnats-submit@FreeBSD.org
Subject: potential minor error in Developer's Handbook + mem(4) man page
X-Send-Pr-Version: www-1.0

>Number:         34460
>Category:       docs
>Synopsis:       potential minor error in Developer's Handbook + mem(4) man page
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    freebsd-doc
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Jan 30 10:10:04 PST 2002
>Closed-Date:    Sun Feb 10 00:52:29 PST 2002
>Last-Modified:  Sun Feb 10 00:52:58 PST 2002
>Originator:     Bruce Dang
>Release:        4.4-PRERELEASE i386
>Organization:
>Environment:
FreeBSD xxxx 4.5-PRERELEASE FreeBSD 4.5-PRERELEASE #1: Wed Dec 26 19:43:22 EST 2001     root@xxxxx:/usr/obj/usr/src/sys/LEET  i386

>Description:
On page 40 of the Developer's Handbook (PDF version), there's something like "will always null terminate the string." Shouldn't this be NUL terinated, instead of NULL (ptr).

In addition to that, the mem(4) man page makes references to <memrange.h> for various #defines, but it is actually <sys/memrange.h> that defines them...
>How-To-Repeat:
- look page 40 of the dev's handbook
- man 4 mem
>Fix:
- change "null" to NUL on p. 40 of the developer's handbook
- change <memrange.h> to <sys/memrange.h> in mem(4) manpage
>Release-Note:
>Audit-Trail:

From: Peter Pentchev <roam@ringlet.net>
To: Bruce Dang <bruce@research.teamxor.org>
Cc: freebsd-gnats-submit@freebsd.org
Subject: Re: docs/34460: potential minor error in Developer's Handbook + mem(4) man page
Date: Wed, 30 Jan 2002 20:22:59 +0200

 On Wed, Jan 30, 2002 at 10:05:25AM -0800, Bruce Dang wrote:
 > 
 > >Number:         34460
 > >Category:       docs
 > >Synopsis:       potential minor error in Developer's Handbook + mem(4) man page
 > >Originator:     Bruce Dang
 > >Description:
 > On page 40 of the Developer's Handbook (PDF version), there's
 > something like "will always null terminate the string." Shouldn't
 > this be NUL terinated, instead of NULL (ptr).
 
 I think this came up recently in another context, and the resolution
 was that both "NUL-terminated" and "null-terminated" were correct, and
 "NULL-terminated" is definitely wrong.  NUL is right in the sense of
 the ASCII character NUL, and 'null' is right in its semantical sense
 of 'zero', 'emptiness' or something like that.  So, although the tide
 may have turned since then, I doubt it, and I think that "null
 terminated" would be right.
 
 > In addition to that, the mem(4) man page makes references to
 > <memrange.h> for various #defines, but it is actually
 > <sys/memrange.h> that defines them...
 
 This looks genuine.  Patch attached for the benefit of -doc
 committers.
 
 G'luck,
 Peter
 
 -- 
 If there were no counterfactuals, this sentence would not have been paradoxical.
 
 Index: src/share/man/man4/mem.4
 ===================================================================
 RCS file: /home/ncvs/src/share/man/man4/mem.4,v
 retrieving revision 1.13
 diff -u -r1.13 mem.4
 --- src/share/man/man4/mem.4	21 Jan 2002 12:09:13 -0000	1.13
 +++ src/share/man/man4/mem.4	30 Jan 2002 18:21:20 -0000
 @@ -77,7 +77,7 @@
  calls performed on
  .Nm /dev/mem .
  Declarations and data types are to be found in
 -.Pa <memrange.h>
 +.Pa <sys/memrange.h>
  .Pp
  The specific attributes, and number of programmable ranges may vary between
  architectures.  The full set of supported attributes is:
State-Changed-From-To: open->closed 
State-Changed-By: dd 
State-Changed-When: Sun Feb 10 00:52:29 PST 2002 
State-Changed-Why:  
As Peter pointed out, the developers handbook part is a non-issue, and 
I've applied his mem(4) patch. 

http://www.FreeBSD.org/cgi/query-pr.cgi?pr=34460 
>Unformatted:
