From setantae@submonkey.net  Mon Dec 31 06:00:33 2001
Return-Path: <setantae@submonkey.net>
Received: from relay3-gui.server.ntli.net (relay3-gui.server.ntli.net [194.168.4.200])
	by hub.freebsd.org (Postfix) with ESMTP id 34C9437B429
	for <FreeBSD-gnats-submit@freebsd.org>; Mon, 31 Dec 2001 06:00:32 -0800 (PST)
Received: from pc3-card4-0-cust122.cdf.cable.ntl.com
	([62.254.251.122] helo=rhadamanth.private.submonkey.net ident=exim)
	by relay3-gui.server.ntli.net with esmtp (Exim 3.03 #2)
	id 16L2zO-0002Zs-00
	for FreeBSD-gnats-submit@freebsd.org; Mon, 31 Dec 2001 14:00:30 +0000
Received: from setantae by rhadamanth.private.submonkey.net with local (Exim 3.33 #1)
	id 16L2zM-0001us-00
	for FreeBSD-gnats-submit@freebsd.org; Mon, 31 Dec 2001 14:00:28 +0000
Message-Id: <E16L2zM-0001us-00@rhadamanth.private.submonkey.net>
Date: Mon, 31 Dec 2001 14:00:28 +0000
From: Ceri <setantae@submonkey.net>
Sender: Ceri <setantae@submonkey.net>
Reply-To: Ceri <setantae@submonkey.net>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: Markup fix for tuning.7
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         33390
>Category:       docs
>Synopsis:       Markup fix for tuning.7
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    ru
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Mon Dec 31 06:10:00 PST 2001
>Closed-Date:    Wed Jan 16 06:21:06 PST 2002
>Last-Modified:  Wed Jan 16 06:21:55 PST 2002
>Originator:     Ceri <setantae@submonkey.net>
>Release:        FreeBSD 4.5-PRERELEASE i386
>Organization:
>Environment:
System: FreeBSD rhadamanth.private.submonkey.net 4.5-PRERELEASE FreeBSD 4.5-PRERELEASE #3: Wed Dec 26 18:27:46 GMT 2001 root@rhadamanth.private.submonkey.net:/usr/obj/usr/src/sys/RHADAMANTH i386


	
>Description:

tuning.7 contains two strange pieces of markup regarding /var/tmp.
I can see why it's been done, since the author clearly wishes to refer to
/tmp and/or /var/tmp, but it looks horrific :  [/var]/tmp

Since the manual page has already suggested symlinking /tmp -> /var/tmp,
it might be best to lose the brackets altogether.
Another option could be to just say "temporary directories".

My suggested patch is below, but if it's decided that this is ok as is,
so be it.

Ceri

>How-To-Repeat:
man tuning
>Fix:

*** src/share/man/man7/tuning.7.old	Mon Dec 31 13:50:09 2001
--- src/share/man/man7/tuning.7	Mon Dec 31 13:51:08 2001
***************
*** 90,100 ****
  two reasons: first, it reduces the possibility of filesystem corruption
  in a crash, and second it reduces the chance of a runaway process that
  fills up
! .Oo Pa /var Oc Ns Pa /tmp
  from blowing up more critical subsystems (mail,
  logging, etc).
  Filling up
! .Oo Pa /var Oc Ns Pa /tmp
  is a very common problem to have.
  .Pp
  In the old days there were differences between
--- 90,100 ----
  two reasons: first, it reduces the possibility of filesystem corruption
  in a crash, and second it reduces the chance of a runaway process that
  fills up
! .Pa /var/tmp
  from blowing up more critical subsystems (mail,
  logging, etc).
  Filling up
! .Pa /var/tmp
  is a very common problem to have.
  .Pp
  In the old days there were differences between
>Release-Note:
>Audit-Trail:

From: Giorgos Keramidas <keramida@FreeBSD.org>
To: Ceri <setantae@submonkey.net>
Cc: FreeBSD-gnats-submit@FreeBSD.org
Subject: Re: docs/33390: Markup fix for tuning.7
Date: Tue, 15 Jan 2002 18:09:53 +0200

 > tuning.7 contains two strange pieces of markup regarding /var/tmp.
 > I can see why it's been done, since the author clearly wishes to refer to
 > /tmp and/or /var/tmp, but it looks horrific :  [/var]/tmp
 
 How about explicitly mentioning both directories in something like:
 
 	temporary directories (usually
 	.Pa /var/tmp
 	or
 	.Pa /tmp ")."
 
 Does this look better to you?
 
 Although I have to admit that [/var]/tmp does not look that bad.
 Brackets are customarily used to denote optional parts in several
 places (command line arguments in SYNOPSIS sections, for example).
 
 -- 
 Giorgos Keramidas . . . . . . . . . keramida@{ceid.upatras.gr,freebsd.org}
 FreeBSD Documentation Project . . . http://www.freebsd.org/docproj/
 FreeBSD: The power to serve . . . . http://www.freebsd.org/

From: Ceri <setantae@submonkey.net>
To: Giorgos Keramidas <keramida@FreeBSD.org>
Cc: FreeBSD-gnats-submit@FreeBSD.org
Subject: Re: docs/33390: Markup fix for tuning.7
Date: Wed, 16 Jan 2002 10:04:12 +0000

 On Tue, Jan 15, 2002 at 06:09:53PM +0200, Giorgos Keramidas wrote:
 > 
 > 	temporary directories (usually
 > 	.Pa /var/tmp
 > 	or
 > 	.Pa /tmp ")."
 > 
 > Does this look better to you?
 
 If it doesn't impact readability, yeah.
 
 > Although I have to admit that [/var]/tmp does not look that bad.
 
 It looks absolutely gross on my console.
 As I mentioned in the PR, if it's ok then it's ok - I think maybe I
 has a hangover that day or something..
 
 > Brackets are customarily used to denote optional parts in several
 > places (command line arguments in SYNOPSIS sections, for example).
 
 Yes, but they're technical specifications almost.
 This appears in a free-form text area.
 
 Ceri
 
 -- 
 keep a mild groove on
State-Changed-From-To: open->closed 
State-Changed-By: ru 
State-Changed-When: Wed Jan 16 06:21:06 PST 2002 
State-Changed-Why:  
Originator didn't mind to leave this as is, and I feel like that. 


Responsible-Changed-From-To: freebsd-doc->ru 
Responsible-Changed-By: ru 
Responsible-Changed-When: Wed Jan 16 06:21:06 PST 2002 
Responsible-Changed-Why:  

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