Bug 33390

Summary: Markup fix for tuning.7
Product: Documentation Reporter: setantae <setantae>
Component: Books & ArticlesAssignee: ru <ru>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description setantae 2001-12-31 14:10:00 UTC 
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
Comment 1 Giorgos Keramidas freebsd_committer freebsd_triage 2002-01-15 16:09:53 UTC 
> 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/
Comment 2 setantae 2002-01-16 10:04:12 UTC 
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
Comment 3 ru freebsd_committer freebsd_triage 2002-01-16 14:21:06 UTC 
State Changed
From-To: open->closed

Originator didn't mind to leave this as is, and I feel like that.
Comment 4 ru freebsd_committer freebsd_triage 2002-01-16 14:21:06 UTC 
Responsible Changed
From-To: freebsd-doc->ru