src/engine/SCons/Tool/Perforce.xml

   1 <!--
   2 __COPYRIGHT__
   3
   4 This file is processed by the bin/SConsDoc.py module.
   5 See its __doc__ string for a discussion of the format.
   6 -->
   7 <tool name="Perforce">
   8 <summary>
   9 Sets construction variables for interacting with the
  10 Perforce source code management system.
  11 </summary>
  12 <sets>
  13 P4
  14 P4FLAGS
  15 P4COM
  16 </sets>
  17 <uses>
  18 P4COMSTR
  19 </uses>
  20 </tool>
  21
  22 <cvar name="P4">
  23 <summary>
  24 The Perforce executable.
  25 </summary>
  26 </cvar>
  27
  28 <cvar name="P4COM">
  29 <summary>
  30 The command line used to
  31 fetch source files from Perforce.
  32 </summary>
  33 </cvar>
  34
  35 <cvar name="P4COMSTR">
  36 <summary>
  37 The string displayed when
  38 fetching a source file from Perforce.
  39 If this is not set, then &cv-link-P4COM; (the command line) is displayed.
  40 </summary>
  41 </cvar>
  42
  43 <cvar name="P4FLAGS">
  44 <summary>
  45 General options that are passed to Perforce.
  46 </summary>
  47 </cvar>