This Repository Options tab allows you to manage options specific to repositories (as opposed to general server options, which apply to all repositories).
Repository
The Repository box is a list of user-defined repositories. Type or select a repository.
All Repositories
The All Repositories option will update each of the other controls with common values for all repositories.
If there are conflicts in Require Check In Comments or Require Exclusive Locks, the checkboxes will be filled with a grey checkmark. Checking this will uncheck the value, and checking it again will check the value with a regular checkmark.
If there are conflicts in the Mergable files text box, the text multiple value) will appear. You can overwrite that text with values that will become common across all repositories.
If there are conflicts in the EOL box, a blank option will be displayed. You can choose a valid option.
As with a single repository, only those values that you actually change will update all the repositories with the new values.
Require Check In Comments
When checked, all check ins to the repository must have a check-in comment.
The default is Unchecked.
Require exclusive locks
When checked, two people cannot have the same file checked out at the same time. This will apply to the entire repository.
The default is Unchecked.
Enable keyword expansion
Check the Enable keyword expansion to expand keywords located in files of the specified types when committed to the Vault repository.
When this is checked, keywords are expanded on the client machine during the Add and Check In operations. After the commit has completed, the file in the repository and the client machine will be in expanded form.
If a file containing keywords is checked in and there were no modifications made to the file and the option for checking in unchanged files is set to Undo Checkout, then the undo checkout will occur and the keywords will not be expanded. If the unmodified file is checked in and the option is set to force the check in, then the check in will occur and the keywords will be expanded in the new version of the file in the repository.
Since keywords are expanded upon Add and Check In, a Get or Check Out of a file containing keywords will be no different from a Get or Check Out of a file without keywords.
Following is a list of supported keywords. This list is identical to the list in Visual Source Safe with the addition of UTCDate and UTCModtime.
Type this keyword |
To add the following |
$Archive: $ |
Vault archive file location |
$Author: $ |
User who last changed the file |
$Date: $ |
Date and time of last check in |
$Header: $ |
Logfile, Revision, Date, Author |
$History: $ |
File history |
$JustDate: $ |
Date, without the time addendum. |
$Log: $ |
File history, RCS format |
$Logfile: $ |
Same as Archive |
$Modtime: $ |
Date and time of last modification |
$Revision: $ |
Vault version number |
$UTCDate: $ |
Same as Date, but time is given in UTC |
$UTCModtime: $ |
Same as Modtime, but time is given in UTC |
$Workfile: $ |
File name |
$NoKeywords: $ |
No keyword expansion for all keywords that follow |
Keywords are case-sensitive and must not include any blank space between the first dollar sign and the colon. Blank space and/or arbitrary text can be included between the colon and the trailing dollar sign.
· History Keywords The History and Log keywords expand to the files current repository path. They result in additional lines being inserted in the file on the line following the keyword. These inserted lines are subsequently treated as text, so no further expansion or changes will occur in them (unless they, in turn, contain keywords).
You can specify optional start and end strings to be placed before and after the inserted lines. For example, .c files could be configured to place /* and */ around inserted lines to make them comments.
· HTML Keywords Two dollar signs can be placed in front of a keyword to specify that it should be formatted as HTML. For example:
$$Author: $
will expand to
$$Author: -->Fred<!-- $
This allows the keyword control characters to be hidden in a document as comments like this:
Last edited by: <!-- $$Author: -->Fred<!-- $ -->
Note that this does not apply to history lines inserted into a file.
· Expanding Keywords When a keyword is expanded, the new information is placed between the colon and the trailing dollar sign. Any existing text is replaced. For example:
$Author: this is some text $
will expand to (assuming Fred was the last person to change the file)
$Author: Fred $
· Preserving Spacing Blank space can be preserved inside a keyword by using two colons. For example:
$Author:: $
will expand to
$Author:: Fred $
Note that this does not apply to history lines inserted into a file.
· Time Formats Dates and times are presented in ISO 8601 format. Time zones are always included, but can be displayed as a number offset ("-06:00" for CST) or "Z" (for UTC time). All times are in 24-hour format, so the AM/PM designator is no longer present.
An example in non-UTC format:
2003-06-30 13:25:57-06:00
An example in UTC format:
2003-06-30 19:25:57Z
The default is Unchecked.
Keyword file types
The Keyword file types box lists the file types, by extension, for which keyword expansion is enabled. Keywords located inside of files having one of the configured extensions will be expanded when committed to the repository as long as the Enable keyword expansion is checked.
· Add Click Add to bring up the Add Keyword box and specify a file extension to be added to the list for Keyword file types.
· Edit Click Edit to bring up the Edit Keyword box and modify the selected file extension.
· Remove Click Remove to remove the selected file extension from the list.
Bug Tracking Application
The Bug Tracking Application allows you to select a bug tracking tool to integrate with this repository. Integrating a bug tracking tool allows users to associate bugs in their bug tracking tool with Vault checkins.
Bug Tracking Integration URL
The Bug Tracking Integration URL box is for entering the URL of the specific bug tracking tool you want to integrate with.
For Vault Dragnet, enter a URL of the form:
http://<dragnetserver>/Dragnet
If you are using FogBUGZ, enter a URL of the form:
http://<fogbugzserver>/fogbugz
Check the Require Bug ID for Checkins checkbox to require users to enter a bug ID during checkins. If Require Bug ID is enabled, users will be forced to enter a bug ID when committing an added or modified file.
Mergeable files
The Mergeable Files box lists the file types that can be merged and therefore can be changed by two users at the same time.
Changing a file type in this list updates the properties for all files of that type to reflect the values in the list.
For example, if you add a file type of .foo to the list, all existing files of type .foo are updated to be mergeable. If .foo is deleted from the list, all files of type foo will no longer be mergeable. File types that were not changed are not affected.
Removing all mergeable file types from the list for a repository will reset the default values.
File Exclusions
The File Exclusions box lists file name patterns that should not be included by default when adding a folder to Vault.
Changing a file pattern in this list updates the file exclusion list in all clients.
Folder Exclusions
The Folder Exclusions box lists folder name patterns that should not be included by default when adding a folder to Vault. The folder pattern applies to any recursive subfolder of the folder you are attempting to add.
Changing a folder pattern in this list updates the folder exclusion list in all clients.
EOL Conversion
The EOL Conversion allows you to select the EOL to be applied to mergeable files only. The list includes:
· None
· Native
· Windows CRLF
· Unix LF
· Mac CR
Note that this does not change existing files in the database. It only affects new files that are added to Vault.
The default EOL type for mergeable files is Native and for binary files is None.
Configure Shadow Folders
The Configure Shadow Folders button brings up the Configure Shadow Folders dialog for the repository listed.
Apply
Click Apply to update the repository options.
If you select a different repository or tab or close the application when changes have been made but not applied, a dialog box is displayed asking if you want to apply the changes. Click Yes to apply the changes. Click No to reset the options to their original values.