6205 Sdiff usr/src/tools/scripts/webrev.1onbld

Print this page

6205 onbld manuals should be declared as 1onbld
Reviewed by: Dan McDonald <danmcd@omniti.com>
Reviewed by: Josef Sipek <jeffpc@josefsipek.net>

   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 .\"
  19 .\" CDDL HEADER END
  20 .\"
  21 .\" Copyright 2010 Sun Microsystems, Inc.  All rights reserved.
  22 .\" Use is subject to license terms.
  23 .\"
  24 .\"
  25 .TH webrev 1 "7 Feb 2014"
  26 .SH NAME
  27 webrev \- Generate HTML codereview materials
  28 .SH SYNOPSIS
  29 .B webrev
  30 [
  31 .I common-options
  32 ]
  33 
  34 .B webrev
  35 [
  36 .I common-options
  37 ]
  38 .I file-list-file
  39 |
  40 .I -
  41 
  42 .B webrev
  43 [
  44 .I common-options
  45 ]

 107            new : bold blue
 108 .fi
 109 
 110 .SH SCM INTERACTIONS
 111 .PP
 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 (1)
 128 or
 129 .BR bldenv (1)
 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.
 136 
 137 .SS Discovering the SCM in use.
 138 .B webrev
 139 makes use of
 140 .BR which_scm (1)
 141 to determine the SCM in use for a given workspace.
 142 
 143 .SS Mercurial
 144 In the case of Mercurial \fBwebrev\fR will attempt to use the output
 145 from the
 146 .BR hg (1)
 147 "hg root" command to identify the workspace root, and the
 148 "hg path default" command to identify the parent workspace.
 149 
 150 .SS Git
 151 In the case of Git \fBwebrev\fR will attempt to use the output from the
 152 .BR git (1)
 153 "git rev-parse --git-dir" command to identify the workspace root, and will
 154 attempt to use the remote branch which the current branch is tracking as the
 155 parent, if none is specified 'origin/master' will be used.
 156 
 157 The parent specified when using git is, in all cases, a git 'tree-ish' and
 158 never an actual git repository, remote or otherwise.  Anything specifiable to
 159 git as a tree-ish should, similarly, be specifiable as a parent for webrev.
 160 This includes branches, explicit revisions, reflog entries, etc. See

 417 \f(CW$ webrev -Do webrev-foo.onnv
 418 .fi
 419 .PP
 420 Otherwise \fBwebrev\fR will attempt to remove remote directory with the same
 421 name as basename of the local repository.
 422 .PP
 423 For the nested directory case it is necessary to specify the full target:
 424 .IP
 425 .nf
 426 \f(CW$ webrev -D -t \\
 427         ssh://user@cr.opensolaris.org:foo/bar/bugfix.onnv
 428 .fi
 429 .PP
 430 This will remove just the \fIbugfix.onnv\fR directory.
 431 
 432 .SH SEE ALSO
 433 .BR hg "(1),"
 434 .BR git "(1),"
 435 .BR ssh_config "(4),"
 436 .BR svn "(1),"
 437 .BR which_scm "(1)"
 438 
 439 .SH ACKNOWLEDGEMENTS
 440 Acknowledgements to Rob Thurlow, Mike Eisler, Lin Ling,
 441 Rod Evans, Mike Kupfer, Greg Onufer, Glenn Skinner,
 442 Oleg Larin, David Robinson, Matthew Cross, David L. Paktor,
 443 Neal Gafter, John Beck, Darren Moffat, Norm Shulman, Bill Watson,
 444 Pedro Rubio and Bill Shannon for valuable feedback and insight in
 445 building webrev.
 446 
 447 Have fun!
 448 .br
 449                 Brent Callaghan  11/28/96
 450

   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 .\"
  19 .\" CDDL HEADER END
  20 .\"
  21 .\" Copyright 2010 Sun Microsystems, Inc.  All rights reserved.
  22 .\" Use is subject to license terms.
  23 .\"
  24 .\"
  25 .TH webrev 1ONBLD "7 Feb 2014"
  26 .SH NAME
  27 webrev \- Generate HTML codereview materials
  28 .SH SYNOPSIS
  29 .B webrev
  30 [
  31 .I common-options
  32 ]
  33 
  34 .B webrev
  35 [
  36 .I common-options
  37 ]
  38 .I file-list-file
  39 |
  40 .I -
  41 
  42 .B webrev
  43 [
  44 .I common-options
  45 ]

 107            new : bold blue
 108 .fi
 109 
 110 .SH SCM INTERACTIONS
 111 .PP
 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.
 136 
 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.
 142 
 143 .SS Mercurial
 144 In the case of Mercurial \fBwebrev\fR will attempt to use the output
 145 from the
 146 .BR hg (1)
 147 "hg root" command to identify the workspace root, and the
 148 "hg path default" command to identify the parent workspace.
 149 
 150 .SS Git
 151 In the case of Git \fBwebrev\fR will attempt to use the output from the
 152 .BR git (1)
 153 "git rev-parse --git-dir" command to identify the workspace root, and will
 154 attempt to use the remote branch which the current branch is tracking as the
 155 parent, if none is specified 'origin/master' will be used.
 156 
 157 The parent specified when using git is, in all cases, a git 'tree-ish' and
 158 never an actual git repository, remote or otherwise.  Anything specifiable to
 159 git as a tree-ish should, similarly, be specifiable as a parent for webrev.
 160 This includes branches, explicit revisions, reflog entries, etc. See

 417 \f(CW$ webrev -Do webrev-foo.onnv
 418 .fi
 419 .PP
 420 Otherwise \fBwebrev\fR will attempt to remove remote directory with the same
 421 name as basename of the local repository.
 422 .PP
 423 For the nested directory case it is necessary to specify the full target:
 424 .IP
 425 .nf
 426 \f(CW$ webrev -D -t \\
 427         ssh://user@cr.opensolaris.org:foo/bar/bugfix.onnv
 428 .fi
 429 .PP
 430 This will remove just the \fIbugfix.onnv\fR directory.
 431 
 432 .SH SEE ALSO
 433 .BR hg "(1),"
 434 .BR git "(1),"
 435 .BR ssh_config "(4),"
 436 .BR svn "(1),"
 437 .BR which_scm "(1ONBLD)"
 438 
 439 .SH ACKNOWLEDGEMENTS
 440 Acknowledgements to Rob Thurlow, Mike Eisler, Lin Ling,
 441 Rod Evans, Mike Kupfer, Greg Onufer, Glenn Skinner,
 442 Oleg Larin, David Robinson, Matthew Cross, David L. Paktor,
 443 Neal Gafter, John Beck, Darren Moffat, Norm Shulman, Bill Watson,
 444 Pedro Rubio and Bill Shannon for valuable feedback and insight in
 445 building webrev.
 446 
 447 Have fun!
 448 .br
 449                 Brent Callaghan  11/28/96
 450