From garys@opusnet.com  Wed Aug 17 23:41:26 2005
Return-Path: <garys@opusnet.com>
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id 3F71416A41F
	for <FreeBSD-gnats-submit@freebsd.org>; Wed, 17 Aug 2005 23:41:26 +0000 (GMT)
	(envelope-from garys@opusnet.com)
Received: from opusnet.com (mail.opusnet.com [209.210.200.6])
	by mx1.FreeBSD.org (Postfix) with ESMTP id EAF9743D46
	for <FreeBSD-gnats-submit@freebsd.org>; Wed, 17 Aug 2005 23:41:25 +0000 (GMT)
	(envelope-from garys@opusnet.com)
Received: from localhost.localhost [70.98.246.232] by opusnet.com with ESMTP
  (SMTPD32-8.05) id AB24BA2900C0; Wed, 17 Aug 2005 16:41:24 -0700
Received: from localhost.localhost (localhost.localhost [127.0.0.1])
	by localhost.localhost (8.13.3/8.13.3) with ESMTP id j7HNgM5b076933
	for <FreeBSD-gnats-submit@freebsd.org>; Wed, 17 Aug 2005 16:42:22 -0700 (PDT)
	(envelope-from garys@opusnet.com)
Received: (from jojo@localhost)
	by localhost.localhost (8.13.3/8.13.3/Submit) id j7HNgHTw076932;
	Wed, 17 Aug 2005 16:42:17 -0700 (PDT)
	(envelope-from garys@opusnet.com)
Message-Id: <dohddot9k6.ddo@mail.opusnet.com>
Date: Wed, 17 Aug 2005 16:42:17 -0700
From: "Gary W. Swearingen" <garys@opusnet.com>
Reply-To: garys@opusnet.com
To: FreeBSD-gnats-submit@freebsd.org
Subject: [patch] builtin(1) manpage has incomplete SYNOPSIS section
X-GNATS-Notify:

>Number:         85066
>Category:       docs
>Synopsis:       [patch] builtin(1) manpage has incomplete SYNOPSIS section
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    ru
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Aug 17 23:50:18 GMT 2005
>Closed-Date:    Fri Oct 13 20:38:08 GMT 2006
>Last-Modified:  Mon Oct 16 12:40:34 GMT 2006
>Originator:     Gary W. Swearingen
>Release:        FreeBSD 5.4-RELEASE i386
>Organization:
none
>Environment:
n/a
>Description:

The builtin(1) manpage covers MANY commands but has a synopsis for
only "builtin" (but no description of "builtin" command).

>How-To-Repeat:
n/a

>Fix:
Remove the SYNOPSIS section.

(An alternative would be to replace the "builtin" synopsis with
a "See the built-in command description in the appropriate shell
manual page.".)

--- builtin..orig.1	Tue Aug  9 10:22:33 2005
+++ builtin.1	Tue Aug  9 10:22:48 2005
@@ -128,10 +128,6 @@
 .Nm which ,
 .Nm while
 .Nd shell builtin commands
-.Sh SYNOPSIS
-.Nm
-.Op Fl options
-.Op Ar args ...
 .Sh DESCRIPTION
 Shell builtin commands are commands that can be executed within the
 running shell's process.


>Release-Note:
>Audit-Trail:
State-Changed-From-To: open->closed 
State-Changed-By: ru 
State-Changed-When: Fri Oct 13 20:37:34 UTC 2006 
State-Changed-Why:  
I've committed an alternative version, thanks! 


Responsible-Changed-From-To: freebsd-doc->ru 
Responsible-Changed-By: ru 
Responsible-Changed-When: Fri Oct 13 20:37:34 UTC 2006 
Responsible-Changed-Why:  

http://www.freebsd.org/cgi/query-pr.cgi?pr=85066 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/85066: commit references a PR
Date: Fri, 13 Oct 2006 20:37:42 +0000 (UTC)

 ru          2006-10-13 20:37:23 UTC
 
   FreeBSD src repository
 
   Modified files:
     share/man/man1       builtin.1 
   Log:
   Make the SYNOPSIS section more meaningful.
   
   PR:             docs/85066
   Submitted by:   Gary W. Swearingen
   MFC after:      3 days
   
   Revision  Changes    Path
   1.27      +2 -4      src/share/man/man1/builtin.1
 _______________________________________________
 cvs-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/cvs-all
 To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/85066: commit references a PR
Date: Mon, 16 Oct 2006 12:32:02 +0000 (UTC)

 ru          2006-10-16 12:31:45 UTC
 
   FreeBSD src repository
 
   Modified files:        (Branch: RELENG_6)
     share/man/man1       builtin.1 
   Log:
   MFC: 1.27: Make the SYNOPSIS section more meaningful.
   
   PR:             docs/85066
   Approved by:    re (hrs)
   
   Revision  Changes    Path
   1.24.2.2  +2 -4      src/share/man/man1/builtin.1
 _______________________________________________
 cvs-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/cvs-all
 To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
 
>Unformatted:
