Using rz_utils

The file rz_utils is a collection of Bourne/Korn shell subroutines which greatly simplifies the task of interacting with the Razor database. It virtually eliminates the need for you to directly parse the various directories and info files, providing a wide variety of functions.

To use rz_utils, your Bourne/Korn shell script will need to "dot" in the file. For example...

#!/bin/sh
. $RAZOR_HOME/scripts/rz_utils
#...continue on from here...

rz_utils does not depend upon any external parameters being set. Once "dotted", you'll be able to take advantage of the functions described below, much as you would a normal UNIX program.

display_issues_from_list <list> [<sig file>]

Dump out the contents of a list of issues. The input file which contains the list must have entries of the form:

<issue group>|<issue number>
        

An optional second parameter may be passed which is the name of a file containing a signature block which should be appended to the output of each issue.

find_state <info file>

Get the highest state value.

find_state_ver <state name> <info file>

Find the version/text for the specified state.

find_transition INFO NEW_INFO

Find the transition from the current state to the new state.

folder_name <name>

Returns the top-level folder name for the given path.

get_activity [-d <delim>] [-p <state>] [-a <action>[...]] <activity file>

Build a list of files that have been related to this issue. This list will contain the highest version of each file.

get_db_field <field name> <info file>

Obtain the value of a database field entry (such as LATEST_VERSION).

get_field [-d <delim>] <attr name> <info file>

Get an attribute value for a given field. If the <delim> is defined, field values will be separated by that delimiter. Otherwise, field values will be space separated.

get_raw_field <field name> <info file>

Get a field without tweaking it like get_field() does. This is useful for getting the value of a TEXT_FIELD.

get_time_field <field name> <info file>

Get the integer time value for a time stamp.

get_time_string <field name> <info file>

Get the time string value for a time stamp.

issues_at_state <state name>

Dump out a list of issues at the selected state.

sort_thread_commands <unsorted thread commands>

Sort a list of threads commands of the form

+ file2 2.5
+ file1 1.7
+ file1 1.6.1
+ file2 2.4

so that for each distinct file name, only one line appears, and the version number is the max of all the version numbers for that file.

NOTE: Note that version numbers cannot be sorted properly with "sort".

state_info <state name> <info file>

Shortcut for file_state_ver().