usr/src/tools/codereview/codereview.1onbld

   1 .\" CDDL HEADER START
   2 .\"
   3 .\" The contents of this file are subject to the terms of the
   4 .\" Common Development and Distribution License (the "License").
   5 .\" You may not use this file except in compliance with the License.
   6 .\"
   7 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   8 .\" or http://www.opensolaris.org/os/licensing.
   9 .\" See the License for the specific language governing permissions
  10 .\" and limitations under the License.
  11 .\"
  12 .\" When distributing Covered Code, include this CDDL HEADER in each
  13 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  14 .\" If applicable, add the following below this CDDL HEADER, with the
  15 .\" fields enclosed by brackets "[]" replaced with your own identifying
  16 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  17 .\"
  18 .\" CDDL HEADER END
  19 .\"
  20 .\" Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
  21 .\" Use is subject to license terms.
  22 .TH CODEREVIEW 1ONBLD "Aug 5, 2008"
  23 .UC
  24 .SH NAME
  25 codereview \- Diff list generator
  26 .SH SYNOPSIS
  27 .B codereview
  28 [-e] [-h\f2heading\fP] [-r]
  29 .I oldfile
  30 .I newfile
  31 .SH DESCRIPTION
  32 .PP
  33 The
  34 .I codereview
  35 command expects two ASCII text files as input
  36 and produces Postscript describing the differences between the files.
  37 The first file is assumed to be the older version,
  38 and the second file is assumed to be the newer version.
  39 If either
  40 .I oldfile
  41 or
  42 .I newfile
  43 is
  44 .BR - ,
  45 the corresponding file is taken from the standard input.
  46 The output goes to standard output and lists all lines from both files,
  47 with lines changed from the first to the second being highlighted in gray.
  48 Lines deleted from the first file are listed in italic,
  49 while lines added to the second file are listed in bold.
  50 .SH OPTIONS
  51 .TP 10
  52 .B \-e
  53 Elide unchanged functions.
  54 Functions which are unchanged will be heuristically eliminated from the listing.
  55 Only the function end is parsed.
  56 The assumption is that a brace ('}')
  57 in column one represents the end of a function.
  58 Thus unchanged structure definitions may be elided also.
  59 For support of assembly language files,
  60 the string "SET_SIZE(" occurring in a line is assumed
  61 to mark the end of a function also.
  62 .TP
  63 .BI \-h heading
  64 Put a header on each page.
  65 The
  66 .I heading
  67 string appears at the upper left of each page,
  68 and the page number appears at the upper right.
  69 .TP
  70 .B \-r
  71 Enable page reversal so that the pages appear in the correct sequence
  72 in the output tray of printers like the Apple LaserWriter.
  73 The default is not to perform page reversal,
  74 which is correct for printers like the NEC Silentwriter LC-890.
  75 .SH FILES
  76 .nf
  77 /tmp/lwlpXXXXXX         \- temporary file used for page reversal
  78 .fi
  79 .SH LIMITATIONS
  80 The maximum input line length is 1024 characters.
  81 This should not present a problem
  82 since the corresponding output line length would be too long to be printed.
  83 The program silently truncates input lines that are too long.
  84 .SH NOTES
  85 The command
  86 .sp 0.5v
  87 pageview -right -h 17 -w 11 -Ws 1100 850 -dpi 100 out.ps
  88 .sp 0.5v
  89 is useful for displaying the results of
  90 .IR codereview .
  91 .SH AUTHOR
  92 John Zolnowsky
  93 .br
  94 SunSoft, Inc.