Print this page
3810 remove support for teamware from webrev

Split Close
Expand all
Collapse all
          --- old/usr/src/tools/scripts/webrev.1
          +++ new/usr/src/tools/scripts/webrev.1
↓ open down ↓ 38 lines elided ↑ open up ↑
  39   39  |
  40   40  .I -
  41   41  
  42   42  .B webrev
  43   43  [
  44   44  .I common-options
  45   45  ]
  46   46  .B -w
  47   47  .I wx-file
  48   48  
  49      -.B webrev 
  50      -[
  51      -.I common-options
  52      -]
  53      -.B -l
  54      -.I arguments to 'putback'
  55      -
  56      -See OPTIONS for common-options.  
  57      -Note that the -l option is only applicable to TeamWare workspaces.
  58      -
  59   49  .SH DESCRIPTION
  60   50  .B webrev
  61   51  builds a set of HTML files suitable for performing code review of
  62   52  source changes in a web browser.
  63      -It supports Mercurial, Git, Subversion and Teamware repositories.
       53 +It supports Mercurial, Git and Subversion repositories.
  64   54  At its most basic, usage is:
  65   55  .nf
  66   56          $ webrev
  67   57  .fi
  68   58  
  69   59  In which case \fBwebrev\fR attempts to figure out the list of files
  70      -for review (note that when using Teamware \fBputback\fR, this may take
  71      -a long time; see the -l option).  If that fails, or if more control
       60 +for review.  If that fails, or if more control
  72   61  over the set of files is needed, a \fIfile list\fR may be specified.
  73   62  \fBwebrev\fR also attempts to deduce a
  74   63  .I basis for comparison
  75   64  (interchangeably called the \fIparent\fR, but see SCM INTERACTIONS below).
  76   65  A basis for comparison is needed in order to determine the differences
  77   66  introduced by the code changes under review.
  78   67  
  79   68  By default, \fBwebrev\fR creates a \fIwebrev\fR directory in the
  80   69  workspace directory that contains the generated HTML files, a generated
  81   70  PDF review, and a patch representing the changes.  It also places a
↓ open down ↓ 62 lines elided ↑ open up ↑
 144  133  To manually specify the basis for comparison, use the -p option or
 145  134  specify the \fBCODEMGR_PARENT\fR variable in either the file list or
 146  135  the environment.
 147  136  
 148  137  .SS Discovering the SCM in use.
 149  138  .B webrev
 150  139  makes use of
 151  140  .BR which_scm (1)
 152  141  to determine the SCM in use for a given workspace.
 153  142  
 154      -.SS TeamWare
 155      -In the case of TeamWare \fBwebrev\fR will use the output of "workspace
 156      -name" to discover the workspace root, if not otherwise specified.
 157      -.PP
 158      -\fBwebrev\fR will attempt to use a 
 159      -.BR wx (1) 
 160      -active list in
 161      -\fBCODEMGR_WS/wx/active\fR.
 162      -To direct \fBwebrev\fR to determine the file list from the output of
 163      -.BR putback "(1),"
 164      -use the -l option.  (Note that \fBwebrev\fR may also elect to use
 165      -\fBputback\fR if it cannot determine the file list from
 166      -.BR wx "(1))."
 167      -The -l option indicates that subsequent arguments should be
 168      -treated as arguments to
 169      -.BR putback "(1)."
 170      -This can be used to prune the set of files which putback examines,
 171      -or to reference a teamware flp (file list program).
 172      -
 173  143  .SS Mercurial
 174  144  In the case of Mercurial \fBwebrev\fR will attempt to use the output
 175  145  from the
 176  146  .BR hg (1)
 177  147  "hg root" command to identify the workspace root, and the
 178  148  "hg path default" command to identify the parent workspace.
 179  149  
 180  150  .SS Git
 181  151  In the case of Git \fBwebrev\fR will attempt to use the output from the
 182  152  .BR git (1)
↓ open down ↓ 47 lines elided ↑ open up ↑
 230  200  .TP 10
 231  201  .BI "-I " information-file
 232  202  Use the specified file to seed the list of information tracking systems.
 233  203  .TP 10
 234  204  .BI "-i " include-file
 235  205  Include the specified file into the index.html file which is generated
 236  206  as part of the webrev.  This allows a snippet of XHTML to be added by
 237  207  the webrev author. User content is contained by a <div> tag and
 238  208  the markup should validate as XHTML 1.0 Transitional.
 239  209  .TP 10
 240      -.BI "-l " putback-args
 241      -Extract the file list from the output of 
 242      -.I putback -n.
 243      -Any arguments supplied will be passed to 
 244      -.BR putback "(1)."
 245      -See SCM INTERACTIONS.  For more information about file
 246      -lists, see FILE LIST.  This argument should appear last.
 247      -.TP 10
 248  210  .BI "-N"
 249  211  Suppress all comments from all output forms html, txt and pdf.
 250  212  .TP 10
 251  213  .BI "-n"
 252  214  Do not generate webrev. Useful whenever only upload is needed.
 253  215  .TP 10
 254  216  .B -O
 255  217  Enable \fIOpenSolaris\fR mode: information tracking system hyperlinks
 256  218  are generated using the EXTERNAL_URL field from the specified its.reg entry,
 257  219  instead of the default INTERNAL_URL_domain field, and sources which appear in
↓ open down ↓ 203 lines elided ↑ open up ↑
 461  423  For the nested directory case it is necessary to specify the full target:
 462  424  .IP
 463  425  .nf
 464  426  \f(CW$ webrev -D -t \\
 465  427          ssh://user@cr.opensolaris.org:foo/bar/bugfix.onnv
 466  428  .fi
 467  429  .PP
 468  430  This will remove just the \fIbugfix.onnv\fR directory.
 469  431  
 470  432  .SH SEE ALSO
 471      -.BR putback "(1),"
 472  433  .BR workspace "(1),"
 473  434  .BR hg "(1),"
 474  435  .BR git "(1),"
 475  436  .BR ssh_config "(4),"
 476  437  .BR svn "(1),"
 477  438  .BR which_scm "(1)"
 478  439  
 479  440  .SH ACKNOWLEDGEMENTS
 480  441  Acknowledgements to Rob Thurlow, Mike Eisler, Lin Ling,
 481  442  Rod Evans, Mike Kupfer, Greg Onufer, Glenn Skinner,
 482  443  Oleg Larin, David Robinson, Matthew Cross, David L. Paktor,
 483  444  Neal Gafter, John Beck, Darren Moffat, Norm Shulman, Bill Watson,
 484  445  Pedro Rubio and Bill Shannon for valuable feedback and insight in
 485  446  building webrev.
 486  447  
 487  448  Have fun!
 488  449  .br
 489  450                  Brent Callaghan  11/28/96
 490  451  
    
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX