1 CODEREVIEW(1ONBLD)            illumos Build Tools           CODEREVIEW(1ONBLD)
   2 
   3 
   4 
   5 
   6 NAME
   7        codereview - Diff list generator
   8 
   9 SYNOPSIS
  10        codereview [-e] [-hheading] [-r] oldfile newfile
  11 
  12 DESCRIPTION
  13        The codereview command expects two ASCII text files as input and
  14        produces Postscript describing the differences between the files.  The
  15        first file is assumed to be the older version, and the second file is
  16        assumed to be the newer version.  If either oldfile or newfile is -,
  17        the corresponding file is taken from the standard input.  The output
  18        goes to standard output and lists all lines from both files, with lines
  19        changed from the first to the second being highlighted in gray.  Lines
  20        deleted from the first file are listed in italic, while lines added to
  21        the second file are listed in bold.
  22 
  23 OPTIONS
  24        -e        Elide unchanged functions.  Functions which are unchanged
  25                  will be heuristically eliminated from the listing.  Only the
  26                  function end is parsed.  The assumption is that a brace ('}')
  27                  in column one represents the end of a function.  Thus
  28                  unchanged structure definitions may be elided also.  For
  29                  support of assembly language files, the string "SET_SIZE("
  30                  occurring in a line is assumed to mark the end of a function
  31                  also.
  32 
  33        -hheading Put a header on each page.  The heading string appears at the
  34                  upper left of each page, and the page number appears at the
  35                  upper right.
  36 
  37        -r        Enable page reversal so that the pages appear in the correct
  38                  sequence in the output tray of printers like the Apple
  39                  LaserWriter.  The default is not to perform page reversal,
  40                  which is correct for printers like the NEC Silentwriter
  41                  LC-890.
  42 
  43 FILES
  44        /tmp/lwlpXXXXXX          - temporary file used for page reversal
  45 
  46 LIMITATIONS
  47        The maximum input line length is 1024 characters.  This should not
  48        present a problem since the corresponding output line length would be
  49        too long to be printed.  The program silently truncates input lines
  50        that are too long.
  51 
  52 NOTES
  53        The command
  54        pageview -right -h 17 -w 11 -Ws 1100 850 -dpi 100 out.ps
  55        is useful for displaying the results of codereview.
  56 
  57 AUTHOR
  58        John Zolnowsky
  59        SunSoft, Inc.
  60 
  61 
  62 
  63 3rd Berkeley Distribution       August 5, 2008              CODEREVIEW(1ONBLD)