VCS Command Properties
Each command has the following properties:
- Command Name - Usually in upper case, used only internally and should
be unique.
- Command Label - Title to be shown in the context menu.
- Execute - External process to be executed to perform this command,
including the text necessary to invoke the shell. For example, under Windows,
cmd.exe c:\CVS\cvs.exe /s status
. See
notes below on variables for a more detailed example.
- Input (optional) - Data that should be
supplied on the standard input of the process. Can contain \n characters
and variables.
- Timeout - The time in milliseconds that the Generic Version Control
System will wait for a response from your version control system before
deciding that it is unavailable and returning an error.
- Data regexp - A POSIX syntax regular expression ("regex") applied
to standard output of your version control system after a command is issued
to it. All matches to this regex will appear in the Version Control System
Command Output window. The exception to this is the command, which is parsed
as described below. By default, the data regex matches every line of output
from your version control system. If you want to filter out some information,
edit the regex.
- Error regexp - A regex applied to the standard error output of the
command for better detection of the error condition. This affords a way
to retrieve more detailed information about command failure than what can
be learned from the exit code of the process. Whenever this regex is matched
on the standard error output, Forte for Java will assume that the command
failed, no matter what the error status of the process is.
- Status, Locker, Attribute, Date, Size, Filename group (LIST
and LIST_SUB commands only) - These are group indexes referring to the
data regex to determine in which sort group of the regex each of these pieces
of information can be found. If your version control system does not return
information in a given category, set that category's group index to -1.
You can optionally define other commands, to support functionality specific
to your version control system. If you want to add additional commands to the
Version Control System context menu, you can do so from the Commands property
editor.
Legal Notices