From swear@blarg.net  Thu Mar 28 19:39:14 2002
Return-Path: <swear@blarg.net>
Received: from lists.blarg.net (lists.blarg.net [206.124.128.17])
	by hub.freebsd.org (Postfix) with ESMTP id E0E6A37B420
	for <FreeBSD-gnats-submit@freebsd.org>; Thu, 28 Mar 2002 19:39:13 -0800 (PST)
Received: from thig.blarg.net (thig.blarg.net [206.124.128.18])
	by lists.blarg.net (Postfix) with ESMTP id 6627EBD7C
	for <FreeBSD-gnats-submit@freebsd.org>; Thu, 28 Mar 2002 19:39:13 -0800 (PST)
Received: from localhost.localdomain ([206.124.139.115])
	by thig.blarg.net (8.9.3/8.9.3) with ESMTP id TAA16105
	for <FreeBSD-gnats-submit@freebsd.org>; Thu, 28 Mar 2002 19:39:07 -0800
Received: (from jojo@localhost)
	by localhost.localdomain (8.11.6/8.11.3) id g2T3bgR98577;
	Thu, 28 Mar 2002 19:37:42 -0800 (PST)
	(envelope-from swear@blarg.net)
Message-Id: <8c8z8cgi2i.z8c@localhost.localdomain>
Date: 28 Mar 2002 19:37:41 -0800
From: "Gary W. Swearingen" <swear@blarg.net>
Reply-To: swear@blarg.net
To: FreeBSD-gnats-submit@freebsd.org
Subject: csh(1) manual references wrong "signal.h".
X-GNATS-Notify:

>Number:         36456
>Category:       docs
>Synopsis:       csh(1) manual references wrong "signal.h".
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Thu Mar 28 19:40:02 PST 2002
>Closed-Date:    Thu May 09 11:58:48 PDT 2002
>Last-Modified:  Thu May 09 11:58:48 PDT 2002
>Originator:     Gary W. Swearingen
>Release:        FreeBSD 4.5-STABLE i386
>Organization:
none
>Environment:
n/a
================
>Description:

The csh(1) manual references "/usr/include/signal.h" while it should
reference "/usr/include/sys/signal.h".

================
>How-To-Repeat:
n/a
================
>Fix:

In the "kill" description, change "signal.h" to "sys/signal.h".
>Release-Note:
>Audit-Trail:

From: Giorgos Keramidas <keramida@freebsd.org>
To: "Gary W. Swearingen" <swear@blarg.net>
Cc: bug-followup@freebsd.org
Subject: Re: docs/36456: csh(1) manual references wrong "signal.h".
Date: Fri, 29 Mar 2002 05:59:51 +0200

 On 2002-03-28 19:37, Gary W. Swearingen wrote:
 > The csh(1) manual references "/usr/include/signal.h" while it should
 > reference "/usr/include/sys/signal.h".
 
 Why?  Anyone who knows enough C to read /usr/include/signal.h can easily
 spot the #include that leads to /usr/include/sys/signal.h:
 
 hades:~$ grep 'signal.h>' /usr/include/signal.h
 #include <sys/signal.h>
 
 > In the "kill" description, change "signal.h" to "sys/signal.h".
 
 But more importantly, csh.1 is hard linked to tcsh.1.gz which comes from
 contrib/ source (the source of /usr/src/contrib/tcsh).  If any changes are
 made to that file, they should probably be made in the tcsh developer's
 source and imported to FreeBSD verbatim when a newer version of tcsh is
 imported to our source.
 
 Giorgos Keramidas                       FreeBSD Documentation Project
 keramida@{freebsd.org,ceid.upatras.gr}  http://www.FreeBSD.org/docproj/

From: swear@blarg.net (Gary W. Swearingen)
To: Giorgos Keramidas <keramida@freebsd.org>
Cc: bug-followup@freebsd.org
Subject: Re: docs/36456: csh(1) manual references wrong "signal.h".
Date: 28 Mar 2002 23:11:35 -0800

 Giorgos Keramidas <keramida@freebsd.org> writes:
 
 > Why?  Anyone who knows enough C to read /usr/include/signal.h can easily
 > spot the #include that leads to /usr/include/sys/signal.h:
 
 Because man page readers might not know any C so he can find the correct
 file but anyone can easily recognize the list of signals in the correct
 file.  Even C readers, especially if not Unix people familiar with signals,
 would waste considerable time figuring it out.  It took me a while.
 
 > But more importantly, csh.1 is hard linked to tcsh.1.gz which comes from
 > contrib/ source (the source of /usr/src/contrib/tcsh).  If any changes are
 > made to that file, they should probably be made in the tcsh developer's
 > source and imported to FreeBSD verbatim when a newer version of tcsh is
 > imported to our source.
 
 I suspect that it's wrong because the tcsh developer's layout is
 different, but that's about all I have to say on it.  (If you don't want
 to fix it one way or the other, I don't see any good reason to not leave
 it open for someone who cares about this low-priority stuff.)

From: Giorgos Keramidas <keramida@freebsd.org>
To: "Gary W. Swearingen" <swear@blarg.net>
Cc: mp@freebsd.org, obrien@freebsd.org, ache@freebsd.org,
	bug-followup@freebsd.org
Subject: Re: docs/36456: csh(1) manual references wrong "signal.h".
Date: Fri, 29 Mar 2002 17:50:19 +0200

 On 2002-03-28 23:11, Gary W. Swearingen wrote:
 > Giorgos Keramidas <keramida@freebsd.org> writes:
 > > But more importantly, csh.1 is hard linked to tcsh.1.gz which comes from
 > > contrib/ source (the source of /usr/src/contrib/tcsh).  If any changes are
 > > made to that file, they should probably be made in the tcsh developer's
 > > source and imported to FreeBSD verbatim when a newer version of tcsh is
 > > imported to our source.
 >
 > I suspect that it's wrong because the tcsh developer's layout is
 > different, but that's about all I have to say on it.  (If you don't want
 > to fix it one way or the other, I don't see any good reason to not leave
 > it open for someone who cares about this low-priority stuff.)
 
 It's not easy to fix this one.  The /usr/include/sys/signal.h file is not
 guaranteed to be there in other systems, AFAIK.  The /usr/include/signal.h
 is something one can depend on, being there on all Unix systems that are
 out there.  The tcsh developers chose to refer to /usr/include to avoid
 writing things like:
 
 	"If you are on FreeBSD ..., but if you are on Linux ..., ..."
 
 The problem here is that FreeBSD uses CVS to track the changes made to
 "vendor code", and making local changes to files that come from the vendor
 branch of a program like tcsh means that this file has to be manually
 merged every time a new version of tcsh is imported :/
 
 I've Cc:'ed the people who have done imports of tcsh to the CVS tree.
 They are the ones that know better than me if such a change needs to be
 done :)
 
 - Giorgos
 

From: swear@blarg.net (Gary W. Swearingen)
To: Giorgos Keramidas <keramida@freebsd.org>
Cc: mp@freebsd.org, obrien@freebsd.org, ache@freebsd.org,
	bug-followup@freebsd.org
Subject: Re: docs/36456: csh(1) manual references wrong "signal.h".
Date: 29 Mar 2002 10:34:37 -0800

 Giorgos Keramidas <keramida@freebsd.org> writes:
 
 > out there.  The tcsh developers chose to refer to /usr/include to avoid
 > writing things like:
 > 
 > 	"If you are on FreeBSD ..., but if you are on Linux ..., ..."
 
 Looks like that could be avoided by referring to use of "kill -l" for
 signal names & numbers; the ksh manual implies that that is a POSIX-
 standard option for that purpose, and it's supported by tcsh's built-
 in "kill".
 
 P.S. If anyone cares more than I do, the tcsh manual refers to
 the first of these as two "forms" and the second as one "form".
     kill [-s signal] %job|pid ...
     migrate [-site] pid|%jobid ... (+)
 which, in context, had me wasting time trying to determine which form
 was being referred to in the description.

From: "David O'Brien" <obrien@freebsd.org>
To: Giorgos Keramidas <keramida@freebsd.org>
Cc: "Gary W. Swearingen" <swear@blarg.net>, mp@freebsd.org,
	ache@freebsd.org, bug-followup@freebsd.org
Subject: Re: docs/36456: csh(1) manual references wrong "signal.h".
Date: Mon, 1 Apr 2002 14:52:08 -0800

 On Fri, Mar 29, 2002 at 05:50:19PM +0200, Giorgos Keramidas wrote:
 > The problem here is that FreeBSD uses CVS to track the changes made to
 > "vendor code", and making local changes to files that come from the vendor
 > branch of a program like tcsh means that this file has to be manually
 > merged every time a new version of tcsh is imported :/
 > 
 > I've Cc:'ed the people who have done imports of tcsh to the CVS tree.
 > They are the ones that know better than me if such a change needs to be
 > done :)
 
 It would be best to handle this such that it does not take something off
 the vendor branch.  However, I will never be doing another tcsh import,
 so my concerns on the matter really isn't that important.
State-Changed-From-To: open->closed 
State-Changed-By: trhodes 
State-Changed-When: Thu May 9 11:58:14 PDT 2002 
State-Changed-Why:  
Problem is on the vendor branch, not within FreeBSD. 

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