10
11 webrev [ common-options ] file-list-file | -
12
13 webrev [ common-options ] -w wx-file
14
15
16 DESCRIPTION
17 webrev builds a set of HTML files suitable for performing code review
18 of source changes in a web browser. It supports Git and Subversion
19 repositories. At its most basic, usage is:
20 $ webrev
21
22 In which case webrev attempts to figure out the list of files for
23 review. If that fails, or if more control over the set of files is
24 needed, a file list may be specified. webrev also attempts to deduce a
25 basis for comparison (interchangeably called the parent, but see SCM
26 INTERACTIONS below). A basis for comparison is needed in order to
27 determine the differences introduced by the code changes under review.
28
29 By default, webrev creates a webrev directory in the workspace
30 directory that contains the generated HTML files, a generated PDF
31 review, and a patch representing the changes. It also places a copy of
32 the file list in that directory, and of both the old and new raw files
33 in the $webrev_root/raw_files directory. To output the webrev
34 somewhere other than the default location, use the -o <outdir> option,
35 or set the WDIR environment variable. For example:
36 $ webrev -o ~/public_html/myreview/
37
38 In the index file, each file is listed on a line with a link to the
39 relevant review materials. Comments for each change will be included
40 automatically. Cross references to bug (or other information) tracking
41 databases in the comments will become hyperlinks in the associated web
42 interface, according to the rules in CROSS REFERENCING below.
43
44 As a review aid, content may be added to the index file in two ways.
45 First, the author may manually edit the file (for example by including
46 text that explains the changes in front of the links for each file).
47 Note that if webrev is run again, manual edits will be lost. Second,
48 if a file named webrev-info is present at the root of the workspace, it
49 will be automatically included in the index file. To include a
50 different file, see the -i option.
51
52 For each file in the file list, webrev compares the file with the
53 version in the basis for comparison (i.e. the parent workspace) and
54 generates a variety of HTML renderings of the differences between the
55 two files; which of these renderings to use is largely a matter of
117 /opt/onbld/etc/its.reg, and the specification of a local domain and
118 selection and prioritization of systems in /opt/onbld/etc/its.conf.
119 These file formats are self documenting. Also see the -I and -C
120 options below.
121
122 OPTIONS
123 -c revision
124 Generate webrev for single commit specified by revision (git
125 only).
126
127 -C priority-file
128 In addition to the system default and an optional user-
129 supplied ~/.its.conf, use the specified file to specify a
130 local domain list and prioritize the list of information
131 tracking systems to be searched automatically when resolving
132 cross references.
133
134 -D Delete remote webrev via SFTP. Default remote host is
135 cr.opensolaris.org, default remote directory for removal is
136 the same as workspace/repository basename. Remote target can
137 be overriden using -t option. If combined with -U the
138 deletion will be performed first. Also, if used together with
139 -U and the removal fails, no upload is done. Without -U
140 option no webrev will be generated, just like if -n option
141 was used. The deletion is done by moving the webrev to
142 special directory in user's home directory. It is expected
143 that the remote host periodically runs a script which deletes
144 the contents of this directory. See the ENVIRONMENT VARIABLES
145 section for more details about this directory.
146
147 -h head-revision
148 Specify the explicit head to generate webrev from (git only).
149
150 -I information-file
151 Use the specified file to seed the list of information
152 tracking systems.
153
154 -i include-file
155 Include the specified file into the index.html file which is
156 generated as part of the webrev. This allows a snippet of
157 XHTML to be added by the webrev author. User content is
158 contained by a <div> tag and the markup should validate as
159 XHTML 1.0 Transitional.
160
161 -N Suppress all comments from all output forms html, txt and
162 pdf.
163
164 -n Do not generate webrev. Useful whenever only upload is
165 needed.
166
167 -O Enable OpenSolaris mode: information tracking system
168 hyperlinks are generated using the EXTERNAL_URL field from
169 the specified its.reg entry, instead of the default
170 INTERNAL_URL_domain field, and sources which appear in
171 usr/closed are automatically elided from the review.
172
173 -o output-dir
174 Place output from running the script in the directory
175 specified. If specified, this option takes precedence over
176 the WDIR environment variable.
177
178 -p basis-of-comparison
179 Specify a basis of comparison meaningful for the SCM
180 currently in use. See SCM INTERACTIONS and INCREMENTAL
181 REVIEWS.
182
361 This will remove just the bugfix.onnv directory.
362
363
364 SEE ALSO
365 git(1), ssh_config(4), svn(1), which_scm(1ONBLD)
366
367
368 ACKNOWLEDGEMENTS
369 Acknowledgements to Rob Thurlow, Mike Eisler, Lin Ling, Rod Evans, Mike
370 Kupfer, Greg Onufer, Glenn Skinner, Oleg Larin, David Robinson, Matthew
371 Cross, David L. Paktor, Neal Gafter, John Beck, Darren Moffat, Norm
372 Shulman, Bill Watson, Pedro Rubio and Bill Shannon for valuable
373 feedback and insight in building webrev.
374
375 Have fun!
376 Brent Callaghan 11/28/96
377
378
379
380
381 March 27, 2016 WEBREV(1ONBLD)
|
10
11 webrev [ common-options ] file-list-file | -
12
13 webrev [ common-options ] -w wx-file
14
15
16 DESCRIPTION
17 webrev builds a set of HTML files suitable for performing code review
18 of source changes in a web browser. It supports Git and Subversion
19 repositories. At its most basic, usage is:
20 $ webrev
21
22 In which case webrev attempts to figure out the list of files for
23 review. If that fails, or if more control over the set of files is
24 needed, a file list may be specified. webrev also attempts to deduce a
25 basis for comparison (interchangeably called the parent, but see SCM
26 INTERACTIONS below). A basis for comparison is needed in order to
27 determine the differences introduced by the code changes under review.
28
29 By default, webrev creates a webrev directory in the workspace
30 directory that contains the generated HTML files, and a patch
31 representing the changes. It also places a copy of the file list in
32 that directory, and of both the old and new raw files in the
33 $webrev_root/raw_files directory. To output the webrev somewhere other
34 than the default location, use the -o <outdir> option, or set the WDIR
35 environment variable. For example:
36 $ webrev -o ~/public_html/myreview/
37
38 In the index file, each file is listed on a line with a link to the
39 relevant review materials. Comments for each change will be included
40 automatically. Cross references to bug (or other information) tracking
41 databases in the comments will become hyperlinks in the associated web
42 interface, according to the rules in CROSS REFERENCING below.
43
44 As a review aid, content may be added to the index file in two ways.
45 First, the author may manually edit the file (for example by including
46 text that explains the changes in front of the links for each file).
47 Note that if webrev is run again, manual edits will be lost. Second,
48 if a file named webrev-info is present at the root of the workspace, it
49 will be automatically included in the index file. To include a
50 different file, see the -i option.
51
52 For each file in the file list, webrev compares the file with the
53 version in the basis for comparison (i.e. the parent workspace) and
54 generates a variety of HTML renderings of the differences between the
55 two files; which of these renderings to use is largely a matter of
117 /opt/onbld/etc/its.reg, and the specification of a local domain and
118 selection and prioritization of systems in /opt/onbld/etc/its.conf.
119 These file formats are self documenting. Also see the -I and -C
120 options below.
121
122 OPTIONS
123 -c revision
124 Generate webrev for single commit specified by revision (git
125 only).
126
127 -C priority-file
128 In addition to the system default and an optional user-
129 supplied ~/.its.conf, use the specified file to specify a
130 local domain list and prioritize the list of information
131 tracking systems to be searched automatically when resolving
132 cross references.
133
134 -D Delete remote webrev via SFTP. Default remote host is
135 cr.opensolaris.org, default remote directory for removal is
136 the same as workspace/repository basename. Remote target can
137 be overridden using -t option. If combined with -U the
138 deletion will be performed first. Also, if used together with
139 -U and the removal fails, no upload is done. Without -U
140 option no webrev will be generated, just like if -n option
141 was used. The deletion is done by moving the webrev to
142 special directory in user's home directory. It is expected
143 that the remote host periodically runs a script which deletes
144 the contents of this directory. See the ENVIRONMENT VARIABLES
145 section for more details about this directory.
146
147 -h head-revision
148 Specify the explicit head to generate webrev from (git only).
149
150 -I information-file
151 Use the specified file to seed the list of information
152 tracking systems.
153
154 -i include-file
155 Include the specified file into the index.html file which is
156 generated as part of the webrev. This allows a snippet of
157 XHTML to be added by the webrev author. User content is
158 contained by a <div> tag and the markup should validate as
159 XHTML 1.0 Transitional.
160
161 -N Suppress all comments from all output forms.
162
163 -n Do not generate webrev. Useful whenever only upload is
164 needed.
165
166 -O Enable OpenSolaris mode: information tracking system
167 hyperlinks are generated using the EXTERNAL_URL field from
168 the specified its.reg entry, instead of the default
169 INTERNAL_URL_domain field, and sources which appear in
170 usr/closed are automatically elided from the review.
171
172 -o output-dir
173 Place output from running the script in the directory
174 specified. If specified, this option takes precedence over
175 the WDIR environment variable.
176
177 -p basis-of-comparison
178 Specify a basis of comparison meaningful for the SCM
179 currently in use. See SCM INTERACTIONS and INCREMENTAL
180 REVIEWS.
181
360 This will remove just the bugfix.onnv directory.
361
362
363 SEE ALSO
364 git(1), ssh_config(4), svn(1), which_scm(1ONBLD)
365
366
367 ACKNOWLEDGEMENTS
368 Acknowledgements to Rob Thurlow, Mike Eisler, Lin Ling, Rod Evans, Mike
369 Kupfer, Greg Onufer, Glenn Skinner, Oleg Larin, David Robinson, Matthew
370 Cross, David L. Paktor, Neal Gafter, John Beck, Darren Moffat, Norm
371 Shulman, Bill Watson, Pedro Rubio and Bill Shannon for valuable
372 feedback and insight in building webrev.
373
374 Have fun!
375 Brent Callaghan 11/28/96
376
377
378
379
380 August 2, 2019 WEBREV(1ONBLD)
|