1 WEBREV(1ONBLD) illumos Build Tools WEBREV(1ONBLD)
2
3
4
5 NAME
6 webrev - Generate HTML codereview materials
7
8 SYNOPSIS
9 webrev [ common-options ]
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 Mercurial, Git and
19 Subversion 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
70 (i.e. the workspace) and the basis for comparison (i.e. the parent).
71 The method for doing so depends upon the SCM in use, which webrev will
72 also attempt to auto-discover. In all cases, webrev must either
73 discover the list of files which have changed, or else this list must
74 be manually specified, either in "webrev file list" format or in "wx"
75 format. See FILE LIST for more details.
76
77 In all cases, if the user has activated the workspace with the
78 ws(1ONBLD) or bldenv(1ONBLD) commands, webrev will use the
79 CODEMGR_PARENT and CODEMGR_WS environment variables to identify parent
80 and child workspaces respectively. To manually specify the basis for
81 comparison, use the -p option or specify the CODEMGR_PARENT variable in
82 either the file list or the environment.
83
84
85 Discovering the SCM in use.
86 webrev makes use of which_scm(1ONBLD) to determine the SCM in use for a
87 given workspace.
88
89
90 Mercurial
91 In the case of Mercurial webrev will attempt to use the output from the
92 hg(1) "hg root" command to identify the workspace root, and the "hg
93 path default" command to identify the parent workspace.
94
95
96 Git
97 In the case of Git webrev will attempt to use the output from the
98 git(1) "git rev-parse --git-dir" command to identify the workspace
99 root, and will attempt to use the remote branch which the current
100 branch is tracking as the parent, if none is specified 'origin/master'
101 will be used.
102
103 The parent specified when using git is, in all cases, a git 'tree-ish'
104 and never an actual git repository, remote or otherwise. Anything
105 specifiable to git as a tree-ish should, similarly, be specifiable as a
106 parent for webrev. This includes branches, explicit revisions, reflog
107 entries, etc. See git-rev-parse(1)
108
109
110 Subversion
111 In the case of Subversion webrev will attempt to use the output from
112 the svn(1) "svn info" to find the workspace root and subversion
113 repository URL.
114
115 The file list will be created from the output of the "svn status"
351 DELETING WEBREVS
352 When deleting a webrev directory on remote site which has a different
353 name than the basename of local repository it is necessary to specify
354 the output option:
355
356 $ webrev -Do webrev-foo.onnv
357
358 Otherwise webrev will attempt to remove remote directory with the same
359 name as basename of the local repository.
360
361 For the nested directory case it is necessary to specify the full
362 target:
363
364 $ webrev -D -t \
365 ssh://user@cr.opensolaris.org:foo/bar/bugfix.onnv
366
367 This will remove just the bugfix.onnv directory.
368
369
370 SEE ALSO
371 hg(1), git(1), ssh_config(4), svn(1), which_scm(1ONBLD)
372
373
374 ACKNOWLEDGEMENTS
375 Acknowledgements to Rob Thurlow, Mike Eisler, Lin Ling, Rod Evans, Mike
376 Kupfer, Greg Onufer, Glenn Skinner, Oleg Larin, David Robinson, Matthew
377 Cross, David L. Paktor, Neal Gafter, John Beck, Darren Moffat, Norm
378 Shulman, Bill Watson, Pedro Rubio and Bill Shannon for valuable
379 feedback and insight in building webrev.
380
381 Have fun!
382 Brent Callaghan 11/28/96
383
384
385
386
387 March 27, 2016 WEBREV(1ONBLD)
|
1 WEBREV(1ONBLD) illumos Build Tools WEBREV(1ONBLD)
2
3
4
5 NAME
6 webrev - Generate HTML codereview materials
7
8 SYNOPSIS
9 webrev [ common-options ]
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
70 (i.e. the workspace) and the basis for comparison (i.e. the parent).
71 The method for doing so depends upon the SCM in use, which webrev will
72 also attempt to auto-discover. In all cases, webrev must either
73 discover the list of files which have changed, or else this list must
74 be manually specified, either in "webrev file list" format or in "wx"
75 format. See FILE LIST for more details.
76
77 In all cases, if the user has activated the workspace with the
78 ws(1ONBLD) or bldenv(1ONBLD) commands, webrev will use the
79 CODEMGR_PARENT and CODEMGR_WS environment variables to identify parent
80 and child workspaces respectively. To manually specify the basis for
81 comparison, use the -p option or specify the CODEMGR_PARENT variable in
82 either the file list or the environment.
83
84
85 Discovering the SCM in use.
86 webrev makes use of which_scm(1ONBLD) to determine the SCM in use for a
87 given workspace.
88
89
90 Git
91 In the case of Git webrev will attempt to use the output from the
92 git(1) "git rev-parse --git-dir" command to identify the workspace
93 root, and will attempt to use the remote branch which the current
94 branch is tracking as the parent, if none is specified 'origin/master'
95 will be used.
96
97 The parent specified when using git is, in all cases, a git 'tree-ish'
98 and never an actual git repository, remote or otherwise. Anything
99 specifiable to git as a tree-ish should, similarly, be specifiable as a
100 parent for webrev. This includes branches, explicit revisions, reflog
101 entries, etc. See git-rev-parse(1)
102
103
104 Subversion
105 In the case of Subversion webrev will attempt to use the output from
106 the svn(1) "svn info" to find the workspace root and subversion
107 repository URL.
108
109 The file list will be created from the output of the "svn status"
345 DELETING WEBREVS
346 When deleting a webrev directory on remote site which has a different
347 name than the basename of local repository it is necessary to specify
348 the output option:
349
350 $ webrev -Do webrev-foo.onnv
351
352 Otherwise webrev will attempt to remove remote directory with the same
353 name as basename of the local repository.
354
355 For the nested directory case it is necessary to specify the full
356 target:
357
358 $ webrev -D -t \
359 ssh://user@cr.opensolaris.org:foo/bar/bugfix.onnv
360
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)
|