1 .\"
   3 .\"
   4 .\" The contents of this file are subject to the terms of the
   5 .\" Common Development and Distribution License (the "License").
   6 .\" You may not use this file except in compliance with the License.
   7 .\"
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9 .\" or http://www.opensolaris.org/os/licensing.
  10 .\" See the License for the specific language governing permissions
  11 .\" and limitations under the License.
  12 .\"
  13 .\" When distributing Covered Code, include this CDDL HEADER in each
  14 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15 .\" If applicable, add the following below this CDDL HEADER, with the
  16 .\" fields enclosed by brackets "[]" replaced with your own identifying
  17 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  18 .\"
  20 .\"
  21 .\" Copyright 2010 Sun Microsystems, Inc.  All rights reserved.
  22 .\" Use is subject to license terms.
  23 .\"
  24 .\" Copyright 2019 Joyent, Inc.
  25 .\"
  26 .TH WEBREV 1ONBLD "Aug 2, 2019"
  27 .SH NAME
  28 webrev \- Generate HTML codereview materials
  30 .B webrev
  31 [
  32 .I common-options
  33 ]
  35 .B webrev
  36 [
  37 .I common-options
  38 ]
  39 .I file-list-file
  40 |
  41 .I -
  43 .B webrev
  44 [
  45 .I common-options
  46 ]
  47 .B -w
  48 .I wx-file
  51 .B webrev
  52 builds a set of HTML files suitable for performing code review of
  53 source changes in a web browser.
  54 It supports Git and Subversion repositories.
  55 At its most basic, usage is:
  56 .nf
  57         $ webrev
  58 .fi
  60 In which case \fBwebrev\fR attempts to figure out the list of files
  61 for review.  If that fails, or if more control
  62 over the set of files is needed, a \fIfile list\fR may be specified.
  63 \fBwebrev\fR also attempts to deduce a
  64 .I basis for comparison
  65 (interchangeably called the \fIparent\fR, but see SCM INTERACTIONS below).
  66 A basis for comparison is needed in order to determine the differences
  67 introduced by the code changes under review.
  69 By default, \fBwebrev\fR creates a \fIwebrev\fR directory in the
  70 workspace directory that contains the generated HTML files, and a patch
  71 representing the changes.  It also places a copy of the file list in
  72 that directory, and of both the old and new raw files in the
  73 \fB$webrev_root/raw_files\fR directory.
  74 To output the webrev somewhere other than the default location, use the
  75 \fI-o <outdir>\fR option, or set the \fBWDIR\fR environment variable.
  76 For example:
  77 .nf
  78         $ webrev -o ~/public_html/myreview/
  79 .fi
  80 .PP
  81 In the index file, each file is listed on a line with a link to the
  82 relevant review materials.  Comments for each change will be included
  83 automatically.  Cross references to bug (or other information) tracking
  84 databases in the comments will become hyperlinks in the associated web
  85 interface, according to the rules in CROSS REFERENCING below.
  87 As a review aid, content may be added to the \fIindex\fR file in two ways.
  88 First, the author may manually edit the file (for example by including
  89 text that explains the changes in front of the links for each file).
  90 Note that if webrev is run again, manual edits will be lost.  Second,
  91 if a file named \fIwebrev-info\fR is present at the root of the workspace,
  92 it will be automatically included in the \fIindex\fR file.  To include a
  93 different file, see the \fI-i\fR option.
  95 For each file in the file list, \fBwebrev\fR compares the file with the
  96 version in the basis for comparison (i.e. the parent workspace) and
  97 generates a variety of HTML renderings of the differences between
  98 the two files; which of these renderings to use is largely a matter
  99 of personal preference.  Additional, webrev emits a patch, the old
 100 and new versions of the file, and a "raw" copy of the file which is
 101 suitable for download.  For files which express differences, source
 102 is formatted according to the following color coding:
 103 .IP
 104 .nf
 105      unchanged : black
 106        removed : brown
 107        changed : blue
 108            new : bold blue
 109 .fi
 112 .B webrev
 113 attempts to interact with the source code management system currently in use.
 114 .B webrev
 115 needs to be able locate the code under review (i.e. the workspace) and
 116 the basis for comparison (i.e. the parent).  The method for doing so
 117 depends upon the SCM in use, which
 118 .B webrev
 119 will also attempt to auto-discover.  In all cases,
 120 .B webrev
 121 must either discover the list of files which have changed, or else this list
 122 must be manually specified, either in "webrev file list" format or in "wx"
 123 format.
 124 See FILE LIST for more details.
 125 .PP
 126 In all cases, if the user has activated the workspace with the
 127 .BR ws (1ONBLD)
 128 or
 129 .BR bldenv (1ONBLD)
 130 commands, \fBwebrev\fR will use the \fBCODEMGR_PARENT\fR and
 131 \fBCODEMGR_WS\fR environment variables to identify parent and child
 132 workspaces respectively.
 133 To manually specify the basis for comparison, use the -p option or
 134 specify the \fBCODEMGR_PARENT\fR variable in either the file list or
 135 the environment.
 137 .SS Discovering the SCM in use.
 138 .B webrev
 139 makes use of
 140 .BR which_scm (1ONBLD)
 141 to determine the SCM in use for a given workspace.
 143 .SS Git
 144 In the case of Git \fBwebrev\fR will attempt to use the output from the
 145 .BR git (1)
 146 "git rev-parse --git-dir" command to identify the workspace root, and will
 147 attempt to use the remote branch which the current branch is tracking as the
 148 parent, if none is specified 'origin/master' will be used.
 150 The parent specified when using git is, in all cases, a git 'tree-ish' and
 151 never an actual git repository, remote or otherwise.  Anything specifiable to
 152 git as a tree-ish should, similarly, be specifiable as a parent for webrev.
 153 This includes branches, explicit revisions, reflog entries, etc. See
 154 .BR git-rev-parse (1)
 156 .SS Subversion
 157 In the case of Subversion \fBwebrev\fR will attempt to use the output
 158 from the
 159 .BR svn (1)
 160 "svn info" to find the workspace root and subversion repository URL.
 161 .PP
 162 The file list will be created from the output of the "svn status" command.
 165 After extracting comments (see FILE LIST below),
 166 .B webrev
 167 will translate cross references into hyperlinks.  By default, information
 168 about available information tracking systems can be found in
 169 /opt/onbld/etc/its.reg, and the specification of a local domain and
 170 selection and prioritization of systems
 171 in /opt/onbld/etc/its.conf.  These file formats are self documenting.  Also
 172 see the -I and -C options below.
 174 .TP 10
 175 .BI "-c " revision
 176 Generate webrev for single commit specified by \fIrevision\fR (git only).
 177 .TP 10
 178 .BI "-C " priority-file
 179 In addition to the system default and an optional user-supplied ~/.its.conf,
 180 use the specified file to specify a local domain list and prioritize the list
 181 of information tracking systems to be searched automatically when resolving cross
 182 references.
 183 .TP 10
 184 .BI "-D"
 185 Delete remote webrev via SFTP. Default remote host is \fIcr.opensolaris.org\fR,
 186 default remote directory for removal is the same as workspace/repository
 187 basename. Remote target can be overridden using -t option. If combined with
 188 -U the deletion will be performed first. Also, if used together with -U
 189 and the removal fails, no upload is done. Without -U option no webrev will
 190 be generated, just like if -n option was used. The deletion is done by
 191 moving the webrev to special directory in user's home directory. It is
 192 expected that the remote host periodically runs a script which deletes
 193 the contents of this directory. See the ENVIRONMENT VARIABLES section for
 194 more details about this directory.
 195 .TP 10
 196 .BI "-h " head-revision
 197 Specify the explicit head to generate webrev from (git only).
 198 .TP 10
 199 .BI "-I " information-file
 200 Use the specified file to seed the list of information tracking systems.
 201 .TP 10
 202 .BI "-i " include-file
 203 Include the specified file into the index.html file which is generated
 204 as part of the webrev.  This allows a snippet of XHTML to be added by
 205 the webrev author. User content is contained by a <div> tag and
 206 the markup should validate as XHTML 1.0 Transitional.
 207 .TP 10
 208 .BI "-N"
 209 Suppress all comments from all output forms.
 210 .TP 10
 211 .BI "-n"
 212 Do not generate webrev. Useful whenever only upload is needed.
 213 .TP 10
 214 .B -O
 215 Enable \fIOpenSolaris\fR mode: information tracking system hyperlinks
 216 are generated using the EXTERNAL_URL field from the specified its.reg entry,
 217 instead of the default INTERNAL_URL_domain field, and sources which appear in
 218 \fIusr/closed\fR are automatically elided from the review.
 219 .TP 10
 220 .BI "-o " output-dir
 221 Place output from running the script in the directory specified.  If
 222 specified, this option takes precedence over the WDIR environment variable.
 223 .TP 10
 224 .BI "-p " basis-of-comparison
 225 Specify a basis of comparison meaningful for the SCM currently in use.
 227 .TP 10
 228 .BI "-t " target
 229 Upload target. Specified in form of URI identifier. For SCP/SFTP it is
 230 \fIssh://user@remote_host:remote_dir\fR and for rsync it is
 231 \fIrsync://user@remote_host:remote_dir\fR. This option can override the
 232 -o option if the URI is fully specified. The target is relative to
 233 the top level directory of the default sftp/rsync directory tree.
 234 .TP 10
 235 .BI "-U"
 236 Upload the webrev. Default remote host is \fIcr.opensolaris.org\fR.
 237 Default transport is rsync. If it fails, fallback to SCP/SFTP transport
 238 is done.
 239 .TP 10
 240 .BI "-w " wx-file
 241 Extract the file list from the wx "active" file specified.  'wx' uses
 242 this mode when invoking webrev.  The list is assumed to be in the
 243 format expected by the \fIwx\fR package.  See FILE LIST, below.
 246 .B Webrev
 247 needs to be told or to discover which files have changed in a
 248 given workspace.  By default,
 249 .B webrev
 250 will attempt to autodetect the
 251 list of changed files by first consulting
 252 .BR wx "(1)."
 253 If this information is not available, webrev tries to consult the SCM (Source
 254 Code Manager) currently in use.  If that fails, the user must intervene by
 255 specifying either a file list or additional options specific to the SCM in use.
 257 .SS Webrev Format
 258 A webrev formatted file list contains a list of all the files to
 259 be included in the review with paths relative to the workspace
 260 directory, e.g.
 261 .IP
 262 .nf
 263 \f(CWusr/src/uts/common/fs/nfs/nfs_subr.c
 264 usr/src/uts/common/fs/nfs/nfs_export.c
 265 usr/src/cmd/fs.d/nfs/mountd/mountd.c
 266 .fi
 267 .PP
 268 Include the paths of any files added, deleted, or modified.
 269 You can keep this list of files in the webrev directory
 270 that webrev creates in the workspace directory
 271 (CODEMGR_WS).
 273 If CODEMGR_WS is not set, it may be specified as an environment variable
 274 within the file list, e.g.
 275 .IP
 276 .nf
 277 \f(CWCODEMGR_WS=/home/brent/myws
 278 usr/src/uts/common/fs/nfs/nfs_subr.c
 279 usr/src/uts/common/fs/nfs/nfs_export.c
 280 usr/src/cmd/fs.d/nfs/mountd/mountd.c
 281 .fi
 282 .PP
 283 To compare the workspace against one other than the parent (see also
 284 the -p option), include a CODEMGR_PARENT line in the file list, like:
 285 .IP
 286 .nf
 287 \f(CWCODEMGR_WS=/home/brent/myws
 288 CODEMGR_PARENT=/ws/onnv-gate
 289 usr/src/uts/common/fs/nfs/nfs_subr.c
 290 usr/src/uts/common/fs/nfs/nfs_export.c
 291 usr/src/cmd/fs.d/nfs/mountd/mountd.c
 292 .fi
 293 .PP
 294 Finally, run webrev with the name of the file containing the file list as an
 295 argument, e.g.
 296 .nf
 297         $ webrev file.list
 298 .fi
 299 .PP
 300 If "-" is supplied as the name of the file, then stdin will be used.
 302 .SS wx Format
 303 If the \fI-w\fR flag is specified then \fBwebrev\fR
 304 will assume the file list is in the format expected by the "wx" package:
 305 pathname lines alternating with SCCS comment lines separated by blank
 306 lines, e.g.
 307 .IP
 308 .nf
 309 \f(CWusr/src/uts/common/fs/nfs/nfs_subr.c
 311 1206578 Fix spelling error in comment
 313 usr/src/uts/common/fs/nfs/nfs_export.c
 315 4039272 cstyle fixes
 317 usr/src/cmd/fs.d/nfs/mountd/mountd.c
 319 1927634 mountd daemon doesn't handle expletives
 320 .fi
 323 When conducting multiple rounds of code review, it may be desirable to
 324 generate a webrev which represents the delta between reviews.  In this
 325 case, set the parent workspace to the path to the old webrev:
 327 .IP
 328 .nf
 329 \f(CW$ webrev -o ~/public_html/myreview-rd2/ \\
 330          -p ~/public_html/myreview/
 331 .fi
 334 The following environment variables allow for customization of \fBwebrev\fR:
 336 .PP
 337 \fBCDIFFCMD\fR and \fBUDIFFCMD\fR are used when generating Cdiffs and Udiffs
 338 respectively; their default values are "diff -b -C 5" and "diff -b -U
 339 5".  To generate diffs with more (or less) than 5 lines of context or
 340 with more (or less) strict whitespace handling, set one or both of
 341 these variables in the user environment accordingly.
 343 \fBWDIR\fR sets the output directory.  It is functionally equivalent to
 344 the \fI-o\fR option.
 346 \fBWDIFF\fR specifies the command used to generate Wdiffs. Wdiff generates a
 347 full unified context listing with line numbers where unchanged
 348 sections of code may be expanded and collapsed.  It also provides a
 349 "split" feature that shows the same file in two HTML frames one above the
 350 other.  The default path for this script is
 351 /ws/onnv-gate/public/bin/wdiff but WDIFF may be set to customize this
 352 to use a more convenient location.
 354 \fBWEBREV_TRASH_DIR\fR specifies alternative location of trash directory
 355 for remote webrev deletion using the \fI-D\fR option. The directory is
 356 relative to the top level directory of the default sftp/rsync directory tree.
 357 The default value of this directory is ".trash".
 360 A webrev can be uploaded to remote site using the -U option. To simply
 361 generate new webrev and upload it to the default remote host use the following
 362 command:
 363 .IP
 364 .nf
 365 \f(CW$ webrev -U
 366 .fi
 367 .PP
 368 This will generate the webrev to local directory named 'webrev' and upload it
 369 to remote host with remote directory name equal to local workspace/repository
 370 name. To change both local and remote directory name, -U can be combined with
 371 -o option. The following command will store the webrev to local directory named
 372 "foo.onnv" and upload it to the remote host with the same directory name:
 373 .IP
 374 .nf
 375 \f(CW$ webrev -U -o $CODEMGR_WS/foo.onnv
 376 .fi
 377 .PP
 378 If there is a need for manual change of the webrev before uploading,
 379 -U can be combined with -n option so that first command will just generate
 380 the webrev and the second command will upload it without generating it again:
 381 .IP
 382 .nf
 383 \f(CW$ webrev
 384 \f(CW$ webrev -n -U
 385 .fi
 386 .PP
 387 For custom remote targets, -t option allows to specify all components:
 388 .IP
 389 .nf
 390 \f(CW$ webrev -U -t \\
 391         ssh://user@cr.opensolaris.org:foo/bar/bugfix.onnv
 392 .fi
 393 .PP
 394 If the remote path is specified as absolute, \fBwebrev\fR will assume all the
 395 directories are already created. If the path is relative, \fBwebrev\fR will
 396 try to create all needed directories. This only works with SCP/SFTP transport.
 397 .PP
 398 By default, rsync transport will use SSH for transferring the data to remote
 399 site. To specify custom username, use entry in SSH client configuration file,
 400 for example:
 401 .IP
 402 .nf
 403 \f(CWHost cr.opensolaris.org
 404   Hostname cr.opensolaris.org
 405   User vkotal
 406 .fi
 409 When deleting a webrev directory on remote site which has a different name
 410 than the basename of local repository it is necessary to specify the output
 411 option:
 412 .IP
 413 .nf
 414 \f(CW$ webrev -Do webrev-foo.onnv
 415 .fi
 416 .PP
 417 Otherwise \fBwebrev\fR will attempt to remove remote directory with the same
 418 name as basename of the local repository.
 419 .PP
 420 For the nested directory case it is necessary to specify the full target:
 421 .IP
 422 .nf
 423 \f(CW$ webrev -D -t \\
 424         ssh://user@cr.opensolaris.org:foo/bar/bugfix.onnv
 425 .fi
 426 .PP
 427 This will remove just the \fIbugfix.onnv\fR directory.
 430 .BR git "(1),"
 431 .BR ssh_config "(4),"
 432 .BR svn "(1),"
 433 .BR which_scm "(1ONBLD)"
 436 Acknowledgements to Rob Thurlow, Mike Eisler, Lin Ling,
 437 Rod Evans, Mike Kupfer, Greg Onufer, Glenn Skinner,
 438 Oleg Larin, David Robinson, Matthew Cross, David L. Paktor,
 439 Neal Gafter, John Beck, Darren Moffat, Norm Shulman, Bill Watson,
 440 Pedro Rubio and Bill Shannon for valuable feedback and insight in
 441 building webrev.
 443 Have fun!
 444 .br
 445 .nf
 446                 Brent Callaghan  11/28/96
 447 .fi