1 webrev(1) User Commands webrev(1)
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
57 versions of the file, and a "raw" copy of the file which is suitable
58 for download. For files which express differences, source is formatted
59 according to the following color coding:
60
61 unchanged : black
62 removed : brown
63 changed : blue
64 new : bold blue
65
66
67 SCM INTERACTIONS
68 webrev attempts to interact with the source code management system
69 currently in use. webrev needs to be able locate the code under review
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 ws(1) or
78 bldenv(1) commands, webrev will use the CODEMGR_PARENT and CODEMGR_WS
79 environment variables to identify parent and child workspaces
80 respectively. To manually specify the basis for comparison, use the -p
81 option or specify the CODEMGR_PARENT variable in either the file list
82 or the environment.
83
84
85 Discovering the SCM in use.
86 webrev makes use of which_scm(1) 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
344 DELETING WEBREVS
345 When deleting a webrev directory on remote site which has a different
346 name than the basename of local repository it is necessary to specify
347 the output option:
348
349 $ webrev -Do webrev-foo.onnv
350
351 Otherwise webrev will attempt to remove remote directory with the same
352 name as basename of the local repository.
353
354 For the nested directory case it is necessary to specify the full
355 target:
356
357 $ webrev -D -t \
358 ssh://user@cr.opensolaris.org:foo/bar/bugfix.onnv
359
360 This will remove just the bugfix.onnv directory.
361
362
363 SEE ALSO
364 hg(1), git(1), ssh_config(4), svn(1), which_scm(1)
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 7 Feb 2014 webrev(1)
|
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
57 versions of the file, and a "raw" copy of the file which is suitable
58 for download. For files which express differences, source is formatted
59 according to the following color coding:
60
61 unchanged : black
62 removed : brown
63 changed : blue
64 new : bold blue
65
66
67 SCM INTERACTIONS
68 webrev attempts to interact with the source code management system
69 currently in use. webrev needs to be able locate the code under review
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
344 DELETING WEBREVS
345 When deleting a webrev directory on remote site which has a different
346 name than the basename of local repository it is necessary to specify
347 the output option:
348
349 $ webrev -Do webrev-foo.onnv
350
351 Otherwise webrev will attempt to remove remote directory with the same
352 name as basename of the local repository.
353
354 For the nested directory case it is necessary to specify the full
355 target:
356
357 $ webrev -D -t \
358 ssh://user@cr.opensolaris.org:foo/bar/bugfix.onnv
359
360 This will remove just the bugfix.onnv directory.
361
362
363 SEE ALSO
364 hg(1), 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 7 Feb 2014 webrev(1ONBLD)
|