From erik@phoenix.smluc.org  Sat Dec  6 07:57:57 2003
Return-Path: <erik@phoenix.smluc.org>
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id CDED916A4CE
	for <FreeBSD-gnats-submit@freebsd.org>; Sat,  6 Dec 2003 07:57:57 -0800 (PST)
Received: from phoenix.smluc.org (phoenix.smluc.org [12.28.48.119])
	by mx1.FreeBSD.org (Postfix) with SMTP id C61D643FD7
	for <FreeBSD-gnats-submit@freebsd.org>; Sat,  6 Dec 2003 07:57:56 -0800 (PST)
	(envelope-from erik@phoenix.smluc.org)
Received: (qmail 6748 invoked by uid 1000); 6 Dec 2003 15:57:42 -0000
Message-Id: <20031206155742.6747.qmail@phoenix.smluc.org>
Date: 6 Dec 2003 15:57:42 -0000
From: Erik Greenwald <erik@smluc.org>
Reply-To: Erik Greenwald <erik@smluc.org>
To: FreeBSD-gnats-submit@freebsd.org
Cc: erik@smluc.org
Subject: diff manpage lacks a return value section
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         59991
>Category:       docs
>Synopsis:       diff manpage lacks a return value section
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    ceri
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          change-request
>Submitter-Id:   current-users
>Arrival-Date:   Sat Dec 06 08:00:36 PST 2003
>Closed-Date:    Sun Nov 28 18:55:25 GMT 2004
>Last-Modified:  Sun Nov 28 18:55:25 GMT 2004
>Originator:     Erik Greenwald
>Release:        FreeBSD 5.2-BETA i386
>Organization:
>Environment:
System: FreeBSD fenris 5.2-BETA FreeBSD 5.2-BETA #0: Fri Nov 28 06:07:45 EST 2003 root@fenris:/usr/src/sys/i386/compile/FENRIS i386


	
>Description:
No text indicates what return values to expect from diff...

>How-To-Repeat:
	
>Fix:


--- diff.1.patch begins here ---
--- gnu/usr.bin/diff/diff.1.orig	Sat Dec  6 10:48:42 2003
+++ gnu/usr.bin/diff/diff.1	Sat Dec  6 10:54:16 2003
@@ -474,6 +474,10 @@
 .TP
 .B \-y
 Use the side by side output format.
+.SH RETURN VALUE
+.I diff
+returns a 0 if the files are identical or a 1 if the files differ. If one or
+both of the files cannot be opened, then the return value is set to 2.
 .SH ENVIRONMENT
 The environment variable
 .B DIFF_OPTIONS
--- diff.1.patch ends here ---


>Release-Note:
>Audit-Trail:

From: Giorgos Keramidas <keramida@freebsd.org>
To: Erik Greenwald <erik@smluc.org>
Cc: bug-followup@freebsd.org
Subject: Re: docs/59991: diff manpage lacks a return value section
Date: Thu, 1 Jan 2004 13:20:36 +0200

 On 2003-12-06 15:57, Erik Greenwald <erik@smluc.org> wrote:
 > No text indicates what return values to expect from diff...
 > [...]
 > --- diff.1.patch begins here ---
 > --- gnu/usr.bin/diff/diff.1.orig	Sat Dec  6 10:48:42 2003
 > +++ gnu/usr.bin/diff/diff.1	Sat Dec  6 10:54:16 2003
 > @@ -474,6 +474,10 @@
 >  .TP
 >  .B \-y
 >  Use the side by side output format.
 > +.SH RETURN VALUE
 > +.I diff
 > +returns a 0 if the files are identical or a 1 if the files differ. If one or
 > +both of the files cannot be opened, then the return value is set to 2.
 >  .SH ENVIRONMENT
 >  The environment variable
 >  .B DIFF_OPTIONS
 
 Nice catch!
 
 Note, though, that it is a good practice to start a new line with every new
 sentence, when writing manpages.  I'd probably write the same diff without
 the 'a' article before numbers too:
 
 %%%
 --- gnu/usr.bin/diff/diff.1.orig	Sat Dec  6 10:48:42 2003
 +++ gnu/usr.bin/diff/diff.1	Sat Dec  6 10:54:16 2003
 @@ -474,6 +474,11 @@
  .TP
  .B \-y
  Use the side by side output format.
 +.SH RETURN VALUE
 +.I diff
 +returns 0 if the files are identical or 1 if the files differ.
 +If one or both of the files cannot be opened,
 +then the return value is set to 2.
  .SH ENVIRONMENT
  The environment variable
  .B DIFF_OPTIONS
 %%%
Responsible-Changed-From-To: freebsd-doc->ceri 
Responsible-Changed-By: ceri 
Responsible-Changed-When: Mon Jan 26 10:56:32 PST 2004 
Responsible-Changed-Why:  
I'll take this. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=59991 
State-Changed-From-To: open->patched 
State-Changed-By: ceri 
State-Changed-When: Sun Feb 1 05:52:27 PST 2004 
State-Changed-Why:  
Patched in -HEAD. 

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

From: Erik Greenwald <erik@smluc.org>
To: keramida@FreeBSD.org
Cc: ceri@FreeBSD.org, freebsd-gnats-submit@FreeBSD.org
Subject: Re: docs/59991: diff manpage lacks a return value section
Date: Wed, 25 Aug 2004 09:30:05 -0500

 ehhh, this should probably be backed out. The info is in the
 'diagnostics' section, I must've missed that. My bad, sorry
 
 -- 
         -Erik <erik@smluc.org> [http://math.smsu.edu/~erik]
 
 The opinions expressed by me are not necessarily opinions. In all probability,
 they are random rambling, and to be ignored. Failure to ignore may result in
 severe boredom or confusion. Shake well before opening. Keep Refrigerated.
State-Changed-From-To: patched->closed 
State-Changed-By: ceri 
State-Changed-When: Sun Nov 28 18:54:47 GMT 2004 
State-Changed-Why:  
This turned out to be unnecessary - keramida backed out the changes I 
had made (thanks).  Thanks to the submitter for the report, anyhow. 

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