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