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 ]
46 .B -w
47 .I wx-file
48
49 .SH DESCRIPTION
50 .B webrev
51 builds a set of HTML files suitable for performing code review of
52 source changes in a web browser.
53 It supports Mercurial, Git and Subversion repositories.
54 At its most basic, usage is:
55 .nf
56 $ webrev
57 .fi
58
59 In which case \fBwebrev\fR attempts to figure out the list of files
60 for review. If that fails, or if more control
61 over the set of files is needed, a \fIfile list\fR may be specified.
62 \fBwebrev\fR also attempts to deduce a
63 .I basis for comparison
64 (interchangeably called the \fIparent\fR, but see SCM INTERACTIONS below).
65 A basis for comparison is needed in order to determine the differences
66 introduced by the code changes under review.
67
68 By default, \fBwebrev\fR creates a \fIwebrev\fR directory in the
69 workspace directory that contains the generated HTML files, a generated
70 PDF review, and a patch representing the changes. It also places a
71 copy of the file list in that directory, and of both the old and new
72 raw files in the \fB$webrev_root/raw_files\fR directory.
73 To output the webrev somewhere other than the default location, use the
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
161 .BR git-rev-parse (1)
162
163 .SS Subversion
164 In the case of Subversion \fBwebrev\fR will attempt to use the output
165 from the
166 .BR svn (1)
167 "svn info" to find the workspace root and subversion repository URL.
168 .PP
169 The file list will be created from the output of the "svn status" command.
419 than the basename of local repository it is necessary to specify the output
420 option:
421 .IP
422 .nf
423 \f(CW$ webrev -Do webrev-foo.onnv
424 .fi
425 .PP
426 Otherwise \fBwebrev\fR will attempt to remove remote directory with the same
427 name as basename of the local repository.
428 .PP
429 For the nested directory case it is necessary to specify the full target:
430 .IP
431 .nf
432 \f(CW$ webrev -D -t \\
433 ssh://user@cr.opensolaris.org:foo/bar/bugfix.onnv
434 .fi
435 .PP
436 This will remove just the \fIbugfix.onnv\fR directory.
437
438 .SH SEE ALSO
439 .BR hg "(1),"
440 .BR git "(1),"
441 .BR ssh_config "(4),"
442 .BR svn "(1),"
443 .BR which_scm "(1ONBLD)"
444
445 .SH ACKNOWLEDGEMENTS
446 Acknowledgements to Rob Thurlow, Mike Eisler, Lin Ling,
447 Rod Evans, Mike Kupfer, Greg Onufer, Glenn Skinner,
448 Oleg Larin, David Robinson, Matthew Cross, David L. Paktor,
449 Neal Gafter, John Beck, Darren Moffat, Norm Shulman, Bill Watson,
450 Pedro Rubio and Bill Shannon for valuable feedback and insight in
451 building webrev.
452
453 Have fun!
454 .br
455 .nf
456 Brent Callaghan 11/28/96
457 .fi
458
|
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 ]
46 .B -w
47 .I wx-file
48
49 .SH DESCRIPTION
50 .B webrev
51 builds a set of HTML files suitable for performing code review of
52 source changes in a web browser.
53 It supports Git and Subversion repositories.
54 At its most basic, usage is:
55 .nf
56 $ webrev
57 .fi
58
59 In which case \fBwebrev\fR attempts to figure out the list of files
60 for review. If that fails, or if more control
61 over the set of files is needed, a \fIfile list\fR may be specified.
62 \fBwebrev\fR also attempts to deduce a
63 .I basis for comparison
64 (interchangeably called the \fIparent\fR, but see SCM INTERACTIONS below).
65 A basis for comparison is needed in order to determine the differences
66 introduced by the code changes under review.
67
68 By default, \fBwebrev\fR creates a \fIwebrev\fR directory in the
69 workspace directory that contains the generated HTML files, a generated
70 PDF review, and a patch representing the changes. It also places a
71 copy of the file list in that directory, and of both the old and new
72 raw files in the \fB$webrev_root/raw_files\fR directory.
73 To output the webrev somewhere other than the default location, use the
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 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.
149
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)
155
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.
412 than the basename of local repository it is necessary to specify the output
413 option:
414 .IP
415 .nf
416 \f(CW$ webrev -Do webrev-foo.onnv
417 .fi
418 .PP
419 Otherwise \fBwebrev\fR will attempt to remove remote directory with the same
420 name as basename of the local repository.
421 .PP
422 For the nested directory case it is necessary to specify the full target:
423 .IP
424 .nf
425 \f(CW$ webrev -D -t \\
426 ssh://user@cr.opensolaris.org:foo/bar/bugfix.onnv
427 .fi
428 .PP
429 This will remove just the \fIbugfix.onnv\fR directory.
430
431 .SH SEE ALSO
432 .BR git "(1),"
433 .BR ssh_config "(4),"
434 .BR svn "(1),"
435 .BR which_scm "(1ONBLD)"
436
437 .SH ACKNOWLEDGEMENTS
438 Acknowledgements to Rob Thurlow, Mike Eisler, Lin Ling,
439 Rod Evans, Mike Kupfer, Greg Onufer, Glenn Skinner,
440 Oleg Larin, David Robinson, Matthew Cross, David L. Paktor,
441 Neal Gafter, John Beck, Darren Moffat, Norm Shulman, Bill Watson,
442 Pedro Rubio and Bill Shannon for valuable feedback and insight in
443 building webrev.
444
445 Have fun!
446 .br
447 .nf
448 Brent Callaghan 11/28/96
449 .fi
450
|