Skip site navigation (1)Skip section navigation (2)
Date:      Tue, 29 Jun 1999 08:50:06 -0700 (PDT)
From:      Sheldon Hearn <sheldonh@uunet.co.za>
To:        freebsd-doc@freebsd.org
Subject:   Re: docs/12440: added an example to diff(1) man page
Message-ID:  <199906291550.IAA00473@freefall.freebsd.org>

next in thread | raw e-mail | index | archive | help
The following reply was made to PR docs/12440; it has been noted by GNATS.

From: Sheldon Hearn <sheldonh@uunet.co.za>
To: freebsd-gnats-submit@freebsd.org
Cc: mpp@freebsd.org
Subject: Re: docs/12440: added an example to diff(1) man page
Date: Tue, 29 Jun 1999 15:13:08 +0200

 The handbook says that the context diff is preferred, but your example
 uses the unified diff. Funnily enough, though, I note that both you and
 I obviously prefer unified diffs. :-)
 
 You should call the section "EXAMPLES" instead of "EXAMPLE" to keep
 the manpage consistent with other manpages and with the guidelines in
 the mdoc.samples(7) manpage.
 
 Also, you really are putting your information in the wrong place. You
 might be able to get away with that by changing the wording. Are you
 happy with the diff below?
 
 Ciao,
 Sheldon.
 
 Index: diff.1
 ===================================================================
 RCS file: /home/ncvs/src/gnu/usr.bin/diff/diff.1,v
 retrieving revision 1.3
 diff -u -d -r1.3 diff.1
 --- diff.1	1996/05/26 22:27:52	1.3
 +++ diff.1	1999/06/29 13:09:26
 @@ -463,6 +463,20 @@
  .TP
  .B \-y
  Use the side by side output format.
 +.SH EXAMPLES
 +To save to a file some changes that you have made to your local source
 +tree (possibly including new files), which you would like to show to others
 +(perhaps using the
 +.B send-pr(1)
 +program), you could type
 +.sp
 +diff -crN foo.orig foo >foo.diff
 +.sp
 +where
 +.I foo.orig
 +and
 +.I foo
 +might be directory hierarchies or single files.
  .SH SEE ALSO
  cmp(1), comm(1), diff3(1), ed(1), patch(1), pr(1), sdiff(1).
  .SH DIAGNOSTICS
 


To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?199906291550.IAA00473>