VCS Command Properties
Each command in a VCS profile has a group of properties that determine
things such as the execution string the IDE uses for the command, what kind of
nodes the command is available for, and how the command output is parsed. The
following are some of the more useful command properties:
- Name - Usually in upper case, used only internally, and should
be unique.
- Label - Title to be shown in the contextual menu.
- Exec - Specifies an execution string in command-line syntax. You can also
specify a Java class. If you use a class, it must be compiled and implement
the
org.netbeans.modules.vcscore.cmdline.VcsAdditionalCommand
interface.
- Confirmation Message Before Execution - Warning question before the command is run.
- Notification Message After Success - Information message that is displayed if
the command succeeds.
- Notification Message After Fail - Message that is displayed if the command fails.
- Data Regex - A POSIX syntax regular expression ("regex") applied
to the standard output of your version control system after a command is issued
to it. All matches to this regex appear in the Data Output tab of the
Output window.
- Error Regex - A regex applied to the standard error output of the
command for better detection of the error condition. All lines that match to
this regular expression will be printed into the Data Error tab. This provides 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, the IDE assumes that the command
failed, no matter what the error status of the process is.
- Visible on Files - If True, the command is available in the contextual
menu of file nodes in the Explorer.
- Visible on Folders - If True, the command is available
in the contextual menu of directory nodes in the Explorer.
- Do Refresh of the Parent Folder - If True, the parent of the current directory is
refreshed after the command is called.
- Disabled on Statuses - Set of statuses of nodes for which this command is to be
disabled. Enclose each status name in quotes and delimit them with commas.
For example,
"Current", "Local"
- Input Descriptor - Defines input dialog before the command is run.
For example,
LABEL("Hello!") PROMPT_FOR(NAME,"What's your name?")
.
- Process All Files - If True, the command is run on all files represented by the selected node or nodes. If False, the command is only run on files designated as "important" for that type of node. For example, on form nodes (
),
.form
files and .java
files are important, but .class
files are unimportant. On Java source nodes (
), .java
files are important and .class
files are unimportant.
- Can Run on Multiple Files - If True, the command is run with all files included in the selection
in the Explorer in its arguments. If False, the command is run separately for each file.
- Do Not Warn of Fail - If True, no message will appear in the Output window if the command fails.
- Hidden - If True, this command does not appear in contextual menus for nodes.
- Index properties (such as File Index and Status Index) - These properties only
apply to the Refresh (LIST) and Refresh Recursively (LIST_SUB) commands. Group indexes refer to the
data regex to determine which sort group of the regex each of these pieces
of information can be found in. If your version control system does not return
information in a given category, set that category's group index to -1.
- Input (optional)- Data that should be
supplied on the standard input of the process. Can contain
\n
characters
and variables.
Legal Notices