From swear@aa.net  Tue Aug  7 20:35:05 2001
Return-Path: <swear@aa.net>
Received: from localhost.localdomain (host68.207.55.120.aadsl.com [207.55.120.68])
	by hub.freebsd.org (Postfix) with ESMTP id 89CD837B40D
	for <FreeBSD-gnats-submit@freebsd.org>; Tue,  7 Aug 2001 20:35:04 -0700 (PDT)
	(envelope-from swear@aa.net)
Received: (from jojo@localhost)
	by localhost.localdomain (8.11.3/8.11.3) id f783YgV57570;
	Tue, 7 Aug 2001 20:34:42 -0700 (PDT)
	(envelope-from swear@aa.net)
Message-Id: <bz66bzteb2.6bz@localhost.localdomain>
Date: 07 Aug 2001 20:34:41 -0700
From: swear@aa.net (Gary W. Swearingen)
Sender: jojo@localhost.localdomain
Reply-To: swear@aa.net
To: FreeBSD-gnats-submit@freebsd.org
Subject: hier(7) has sometimes-erroneous descriptions of tmp dirs.
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         29525
>Category:       docs
>Synopsis:       hier(7) has sometimes-erroneous descriptions of tmp dirs.
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    murray
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Tue Aug 07 20:40:01 PDT 2001
>Closed-Date:    Thu Oct 18 01:21:09 PDT 2001
>Last-Modified:  Thu Oct 18 01:21:27 PDT 2001
>Originator:     Gary W. Swearingen
>Release:        FreeBSD 4.3-STABLE i386
>Organization:
none
>Environment:
n/a
================
>Description:

The descriptions in hier(7) of /tmp and /var/tmp may lead users to make
inefficient or dangerous-to-their-data usage of the directories.  The
descriptions state policies of tmp file deletion that are not in effect
on many systems which don't bother to make a custom hier(7).
================
>How-To-Repeat:
n/a
================
>Fix:

Change the descriptions to say, in essence, that file deletion is
at the system administrators' discretion/policy in both directories.

It would probably be prudent to vet the changes with well-experienced
SAs; I'm just an experienced user and home SA.

patch -d "some man/man1" < this-PR

*** /tmp/old-hier.7	Tue Aug  7 19:20:19 2001
--- hier.7		Tue Aug  7 19:51:36 2001
***************
*** 139,145 ****
  .It Pa /stand/
  programs used in a standalone environment
  .It Pa /tmp/ 
! temporary files
  .It Pa /usr/
  contains the majority of user utilities and applications 
  .Pp
--- 139,148 ----
  .It Pa /stand/
  programs used in a standalone environment
  .It Pa /tmp/ 
! temporary files; system administrators have differing policies about what
! temporary means; the traditional theory is that /tmp is emptied at system
! bootup and old or big files are deleted at the SA's discretion, but
! often the bootup-deletion is not done
  .It Pa /usr/
  contains the majority of user utilities and applications 
  .Pp
***************
*** 718,724 ****
  .El
  .Pp
  .It Pa tmp/ 
! temporary files that are kept between system reboots
  .Bl -tag -width Fl -compact
  .It Pa vi.recover/
  the directory where recovery files are stored
--- 721,730 ----
  .El
  .Pp
  .It Pa tmp/ 
! temporary files; system administrators have differing policies about what
! temporary means; the traditional theory is that /var/tmp is emptied only at
! the SA's discretion and not at every system bootup, but it is sometimes
! linked with the /tmp which is sometimes emptied at bootup
  .Bl -tag -width Fl -compact
  .It Pa vi.recover/
  the directory where recovery files are stored
>Release-Note:
>Audit-Trail:
State-Changed-From-To: open->feedback 
State-Changed-By: dd 
State-Changed-When: Mon Sep 3 09:26:23 PDT 2001 
State-Changed-Why:  
I don't like how this duplicates information.  How about just adding a 
NOTES or CAVEATS section at the bottom warning that the entire 
filesystem hierarchy is at the SA's discretion, and that stuff in 
there is only supposed to reflect the FreeBSD default? 

http://www.FreeBSD.org/cgi/query-pr.cgi?pr=29525 

From: Murray Stokely <murray@FreeBSD.org>
To: freebsd-gnats-submit@FreeBSD.org, swear@aa.net
Cc:  
Subject: Re: docs/29525: hier(7) has sometimes-erroneous descriptions of tmp dirs.
Date: Sun, 7 Oct 2001 21:00:37 -0700

 How about the following patch?  Does this please everyone?
 
 Index: hier.7
 ===================================================================
 RCS file: /home/ncvs/src/share/man/man7/hier.7,v
 retrieving revision 1.57
 diff -u -r1.57 hier.7
 --- hier.7	2001/10/01 08:52:40	1.57
 +++ hier.7	2001/10/08 03:58:09
 @@ -752,6 +752,12 @@
  the NIS maps
  .El
  .El
 +.Sh NOTES
 +This manual page documents the default FreeBSD filesystem layout, but
 +the actual hierarchy on a given system is defined at the system
 +administrator's discretion.
 +A well-maintained installation will include a customized version of
 +this document.
  .Sh SEE ALSO
  .Xr apropos 1 ,
  .Xr find 1 ,
State-Changed-From-To: feedback->analyzed 
State-Changed-By: murray 
State-Changed-When: Sat Oct 13 14:49:39 PDT 2001 
State-Changed-Why:  
Updated text has been committed to -CURRENT.  Thanks! 



Responsible-Changed-From-To: freebsd-doc->murray 
Responsible-Changed-By: murray 
Responsible-Changed-When: Sat Oct 13 14:49:39 PDT 2001 
Responsible-Changed-Why:  
My MFC reminder. 

http://www.FreeBSD.org/cgi/query-pr.cgi?pr=29525 
State-Changed-From-To: analyzed->closed 
State-Changed-By: murray 
State-Changed-When: Thu Oct 18 01:21:09 PDT 2001 
State-Changed-Why:  
Your change has been merged to -STABLE.  Thanks! 


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