vtk_retrace

vtk_retrace

Usage         vtk_retrace cmd args

Description   Interface to vtk_retrace_check get -- Get all retraces info id -display info id -duration info id -message info id -mode info id -name info id -percentdone info id -user

vtk_retrace_check

Usage:         
vtk_retrace_check none.

Description:   
Retrieves information about all existing retrace requests.

Returns:       
A big formatted string.

vtk_retrace_format

Usage:         
vtk_retrace_format retraceId

Description:

Example:
vtk_retrace_format 123445
,---------------------------------------------------------
|  Retrace     : tmp:retrace:dir ${TOP}/src/doc
|  Id          : 04568415
|  Requested by: john@bison:0.0
|  Priority    : normal
|  Mode        : SAFE/CROSSBARRIERS
|  Work to do  : 14  tools
|  Status      : Is late.
`---------------------------------------------------------


Returns:       
A formatted string

vtk_retrace_get

Usage:         
vtk_retrace_get retraceId <array>

Description:   
Get information about the given retrace. 

Examples:
vtk_retrace_get 45678
1049577954 25s 988 14 {tmp:retrace:dir${TOP}/src/doc} john bison:0.0 {}
vtk_retrace_get 45678 array
1049577954 25s 988 14 {tmp:retrace:dir${TOP}/src/doc} john bison:0.0 {}
parray array


Returns:
A list of:

1. starttime 
2. estimated duration
3. percent done
4. jobs to do
5. description
6. user
7. display
8. message

vtk_retrace_start

Usage:         
vtk_retrace_start priorities mode target [aux]

Description:
This procedure supports the following arguments

1. priorities mode ALL
2. priorities mode NODE nodeId
3. priorities mode SET setId
4. priorities mode DIRECTORY dirName
5. (obsolete) priorities mode BACKWARD nodeId
6. (obsolete) priorities mode FORWARD nodeId
7. [-priorities <sched_priority[.exec_priority]>] [-mode <mode>] [-resources resourcelist] [-target <target> <aux>] [-client] [-array <arrayname>] [-first] [-nop]

The argument priorities specifies both the scheduling and the execution priority using a "." to separate the two. You can specify only the scheduling priority. The default value for priority is "NORMAL.UNDEF".

You can also specify the priority with respect to the priority used last time for each job in the target, by using the specification "SAME", "INCR", or "DECR" (case insensitive).

The argument mode is a list of keywords from the following set: SAFE FAST AGGRESSIVE FORCE CROSSBARRIERS and at most one of these keywords used choose which files to check SKIPCHECK CHECKALL. Normally, only the primary inputs and the barriers are checked. With SKIPCHECK, no file is checked, with CHECKALL, all files in the upcone of the target is checked. The default value for mode is "SAFE". 
   
Examples:
vtk_retrace_start NORMAL SAFE ALL
04568246 {} OK
vtk_retrace_start NORMAL.LOW SAFE ALL
04568246 {} OK
vtk_retrace_start HIGH.2 SET [vtk_set_find All:linux]
04568255 {} OK
vtk_retrace_start LOW "FORCE SKIPCHECK" BACKWARD $nodeId
04568259 {} ERROR
vtk_retrace_start -mode "FORCE SKIPCHECK" -target BACKWARD $nodeId
04568259 {} ERROR

Returns:       
A list id msg status, where

* id is the VovId of the retrace request
* msg is a descriptive message
* status is one of OK, CHANGE, NOTHING, ERROR. 

For ease of use, however, we recommend using the -array option and refer to the fields returned in the array. See the following example.

retraceInfo(desc)           = a description
retraceInfo(display)        = bison:0.0
retraceInfo(id)             = 00092189
retraceInfo(message)        =
retraceInfo(mode)           = SAFE
retraceInfo(percent)        = 0
retraceInfo(priority,exec)  = 4
retraceInfo(priority,sched) = 4
retraceInfo(result)         = OK
retraceInfo(size)           = 1
retraceInfo(start)          = 1137786571
retraceInfo(status)         = IN PROGRESS
retraceInfo(user)           = someuser
retraceInfo(xdur)           = 10

vtk_retrace_start_job_or_set

Usage:         
vtk_retrace_start_job_or_set [OPTIONS]

Description:
This is similar to vtk_retrace_start, but it is a bit more efficient and a bit less flexible. This procedure supports the following arguments

    [-priority <sched_priority[.exec_priority]>] [-mode <mode>] [-resources resourcelist] [-target <target> <aux>] [-first] [-nop]

You can also specify the priority with respect to the priority used last time for each job in the target, by using the specification "SAME", "INCR", or "DECR" (case insensitive).

The argument mode is a list of keywords from the following set: SAFE FAST AGGRESSIVE FORCE CROSSBARRIERS and at most one of these keywords used choose which files to check SKIPCHECK CHECKALL. Normally, only the primary inputs and the barriers are checked. With SKIPCHECK, no file is checked, with CHECKALL, all files in the upcone of the target is checked. The default value for mode is "SAFE".    

Examples:
vtk_retrace_start_job_or_set -pri "NORMAL" -mode "SAFE" -targetid [vtk_set_find System:jobs]
OK
vtk_retrace_start_job_or_set -pri "NORMAL.LOW" -mode "SAFE" -targetid [vtk_set_find System:job]
OK
vtk_retrace_start_job_or_set -pri "HIGH.2" -targetid  [vtk_set_find All:linux]
OK
vtk_retrace_start_job_or_set -pri  "LOW" -mode  "FORCE SKIPCHECK" -targetid $nodeId
OK
vtk_retrace_start -mode "FORCE SKIPCHECK" -targetid $nodeId

Returns:       
A list OK or a descriptive error

vtk_retrace_stop

Usage:         
vtk_retrace_stop retraceId | "-all"  -why TEXT_REASON

Description:   
Stop the given retrace. If the option -all is given instead of a retrace id, then all retrace requests are stopped, provided you have authorization to stop them. The optional reason is passed to eventually get set on the WHYSTATUS field and property of affected nodes. 

Examples:
vtk_retrace_stop -all -why "Custom script stopping all retraces"
vtk_retrace_stop 1234345
vtk_retrace_stop 12345 45678 -why "Stop 2 retraces in one call"

Returns:       
Nothing