EOL Conversion Handling

Explains how StarTeam handles EOL (end of line) characters for text files during conversion.

EOL Conversion Handling Overview

StarTeam provides support for fixed EOL conversion files. For example, files can be checked out in LF format on every platform, regardless of specific options. Also, Update Status works for all text files once EOL Format is defined, regardless of what EOL format was used when they were checked-out. For compatibility with older releases of the Cross-Platform Client, if check-out "EOL conversion" is not requested, and EOL Format is Undefined, files are still checked out with the EOL conversion with which they were added to the StarTeam Server.

Note: The default for automatic EOL conversion for check-out operations is “checked” if the user does not have that option defined already.

Back to top

EOL Format Property

The EOL Format Property displays as EOL Character in the Cross-Platform Client Items pane.

The EOL Format property is only meaningful for text files during the check-out operation.

By default, the SDK will compute the EOL Format when a new text file is added or a new revision is checked in for a text file whose EOL Format is Undefined, the file's EOL convention matches the platform default, or EOL Format is set to Client Defined. Otherwise, EOL Format is set to the convention found: Fixed LF, Fixed CR, or Fixed CRLF :

  • The user can change EOL Format to any value (other than Undefined) at any time.
  • Regardless of their EOL Format setting, text files always use a canonical (CRLF) format in the vault.

The EOL Format property can be manually set in the Cross-Platform Client in the Add/Check-in dialog boxes, and the File Properties dialog box. The Cross-Platform Client EOL conversion for add/check-in options are not available.

Back to top

EOL Property Values

The EOL property value is displayed as EOL Character in the Cross-Platform Client Items pane.

The EOL Format property can be set in the Cross-Platform Client in the Add/Check-in and File Properties dialog boxes. If selected in the Add/Check-in dialog box, StarTeam uses the settings specified in the File Properties dialog box.

The EOL Property values are:

Undefined (null in the SDK).
Client Defined Causes workstation default or per-checkout EOL conversion option to be used.
Fixed CR, Fixed LF, Fixed CRLF Causes this EOL format to be used always; the workstation/check-out conversion option is ignored.

Back to top

Controlling EOL Characters

You can specify which EOL and path case sensitivity settings are active for file check-out operations that you perform.

To control whether EOL Conversion is active for a folder, do the following:

  1. Choose Tools > Personal Options to open the Personal Options dialog box.
  2. Select the File tab.
  3. Select or clear Automatic EOL Conversion On Check-out.
  4. Click the appropriate radio button to specify whether you are working on Windows, Unix, or Mac.

Back to top