From sluggo@unknown.nu  Wed Sep 25 08:46:48 2002
Return-Path: <sluggo@unknown.nu>
Received: from mx1.FreeBSD.org (mx1.FreeBSD.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id C49EB37B401
	for <FreeBSD-gnats-submit@freebsd.org>; Wed, 25 Sep 2002 08:46:48 -0700 (PDT)
Received: from jinx.unknown.nu (jinx.unknown.nu [66.201.234.47])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 6289643E6A
	for <FreeBSD-gnats-submit@freebsd.org>; Wed, 25 Sep 2002 08:46:48 -0700 (PDT)
	(envelope-from sluggo@unknown.nu)
Received: by jinx.unknown.nu (Postfix, from userid 1002)
	id 66453100; Wed, 25 Sep 2002 11:46:47 -0400 (EDT)
Message-Id: <20020925154647.66453100@jinx.unknown.nu>
Date: Wed, 25 Sep 2002 11:46:47 -0400 (EDT)
From: Kim Scarborough <sluggo@unknown.nu>
Reply-To:
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: Man page for hier(7) doesn' have /var/empty
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         43364
>Category:       docs
>Synopsis:       Man page for hier(7) doesn' have /var/empty
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    ceri
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Sep 25 08:50:02 PDT 2002
>Closed-Date:    Thu Oct 10 12:24:24 PDT 2002
>Last-Modified:  Thu Oct 10 12:24:24 PDT 2002
>Originator:     Kim Scarborough
>Release:        FreeBSD 4.6.2-RELEASE i386
>Organization:
none
>Environment:
System: FreeBSD jinx.unknown.nu 4.6.2-RELEASE FreeBSD 4.6.2-RELEASE #2: Sat Aug 24 09:57:25 EDT 2002 toor@jinx.unknown.nu:/usr/src/sys/compile/JINX i386


>Description:
 The man page for hier(7) doesn't explain what /var/empty is.
>How-To-Repeat:
man 7 hier
>Fix:
*** hier.7.ORIG Wed May 29 13:30:56 2002
--- hier.7      Wed Sep 25 11:40:05 2002
***************
*** 689,694 ****
--- 689,698 ----
  .Pp
  .It Pa db/
  misc. automatically generated system-specific database files
+ .It Pa empty/
+ empty directory used by sshd(8) for privilege separation;
+ see
+ .Xr sshd 8
  .It Pa games/
  misc. game status and score files
  .It Pa log/
>Release-Note:
>Audit-Trail:

From: swear@attbi.com (Gary W. Swearingen)
To: Kim Scarborough <sluggo@unknown.nu>
Cc: FreeBSD-gnats-submit@FreeBSD.org
Subject: Re: docs/43364: Man page for hier(7) doesn' have /var/empty
Date: 25 Sep 2002 10:29:28 -0700

 > + empty directory used by sshd(8) for privilege separation;
 > + see
 > + .Xr sshd 8
 
 That huge manual doesn't need the extra words "for privilege separation"
 which will make sense to few and which those who "see sshd(8)" will find
 used there (as if it'll be of any real help to them).

From: "Kim Scarborough" <sluggo@unknown.nu>
To: "Gary W. Swearingen" <swear@attbi.com>
Cc: <FreeBSD-gnats-submit@FreeBSD.org>
Subject: Re: docs/43364: Man page for hier(7) doesn' have /var/empty
Date: Wed, 25 Sep 2002 12:42:57 -0500

 > That huge manual doesn't need the extra words "for privilege separation"
 > which will make sense to few and which those who "see sshd(8)" will find
 > used there (as if it'll be of any real help to them).
 
 Heh, as opposed to user-friendly terms such as "POSIX real-time extensions
 includes" or "genclass prototype/template class files", I suppose. If the 15
 bytes saved by the deletion of those three words is really that important,
 then yeah, take it out; otherwise, I think it should follow the format of just
 about every other cross-referenced listing in there and have a brief
 explanation of its function.
 
 

From: swear@attbi.com (Gary W. Swearingen)
To: "Kim Scarborough" <sluggo@unknown.nu>
Cc: <FreeBSD-gnats-submit@FreeBSD.org>
Subject: Re: docs/43364: Man page for hier(7) doesn' have /var/empty
Date: 25 Sep 2002 15:20:32 -0700

 "Kim Scarborough" <sluggo@unknown.nu> writes:
 
 > > That huge manual doesn't need the extra words "for privilege separation"
 > > which will make sense to few and which those who "see sshd(8)" will find
 > > used there (as if it'll be of any real help to them).
 > 
 > Heh, as opposed to user-friendly terms such as "POSIX real-time extensions
 > includes" or "genclass prototype/template class files", I suppose. If the 15
 > bytes saved by the deletion of those three words is really that important,
 > then yeah, take it out; otherwise, I think it should follow the format of just
 > about every other cross-referenced listing in there and have a brief
 > explanation of its function.
 
 It's not about saving 15 bytes.  It's about saving people from having to
 think about an explanation which explains nothing.  It's just noise.
 Following the bad example of some other entries of the manual only makes
 a poor manual worse.

From: Ceri Davies <ceri@FreeBSD.org>
To: Kim Scarborough <sluggo@unknown.nu>
Cc: FreeBSD-gnats-submit@freebsd.org
Subject: Re: docs/43364: Man page for hier(7) doesn' have /var/empty
Date: Thu, 26 Sep 2002 18:07:16 +0100

 Gary W. Swearingen wrote:
 >On Wed, Sep 25, 2002 at 11:46:47AM -0400, Kim Scarborough wrote:
 > 
 >  > + empty directory used by sshd(8) for privilege separation;
 >  > + see
 >  > + .Xr sshd 8
 >  
 >  That huge manual doesn't need the extra words "for privilege separation"
 >  which will make sense to few and which those who "see sshd(8)" will find
 >  used there (as if it'll be of any real help to them).
 
 I think it's reasonable to expect users to cross-reference manuals.
 With the privilege separation pointer, they'll know what they are looking for
 when they fire up the sshd manual as well.
 
 Ceri
 
 -- 
 you can't see when light's so strong
 you can't see when light is gone
State-Changed-From-To: open->patched 
State-Changed-By: ceri 
State-Changed-When: Thu Sep 26 10:12:20 PDT 2002 
State-Changed-Why:  
Your patch was committed to -current. 
Thanks for your submission. 


Responsible-Changed-From-To: freebsd-doc->ceri 
Responsible-Changed-By: ceri 
Responsible-Changed-When: Thu Sep 26 10:12:20 PDT 2002 
Responsible-Changed-Why:  
My MFC reminder. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=43364 
State-Changed-From-To: patched->closed 
State-Changed-By: ceri 
State-Changed-When: Thu Oct 10 12:24:02 PDT 2002 
State-Changed-Why:  
Your change was MFC'd.  Thanks again! 

http://www.freebsd.org/cgi/query-pr.cgi?pr=43364 
>Unformatted:
