clearexport_sccs

Converts SCCS files to ClearCase elements

APPLICABILITY

ClearCase (administrative command)

SYNOPSIS

clearexport_sccs [ -r ] [ -s date-time | -I { now | date-time } ]

[ -V ] [ -t temp-dir-pname ] [ -T translation-file ]
[ -o datafile-pname ] [ source-name ... ]

DESCRIPTION

The clearexport_sccs command exports Source Code Control System (SCCS) files so they can be imported into ClearCase elements and versions. The source data can range from a single file to an entire directory tree.

During the export stage, you invoke clearexport_sccs in the area where the SCCS files reside. clearexport_sccs creates a datafile (by default, named cvt_data) containing descriptions of elements, branches, and versions. If any of the files to be processed reside below (rather than in) the current working directory, clearexport_sccs includes descriptions of the corresponding directory element(s) in datafile. clearexport_sccs follows symbolic links it encounters during the export stage.

In the import stage, you invoke clearimport on datafile to import information into the new VOB.

clearexport_sccs ignores information in SCCS files that is not related to version-tree structure; this includes flags, ID keywords, user lists, and Modification Request numbers. You can specify a translation file to control naming, enforcing consistency over multiple invocations of clearexport_sccs. You can use the -V option to preserve SCCS-IDs as attributes of the corresponding ClearCase versions.

clearexport_sccs and clearimport use ClearCase magic files to determine which element type should be used for each element clearimport creates. For more information on magic files and file typing, see the cc.magic reference page.

NOTE: You cannot run clearexport_sccs on UNIX and then run clearimport on Windows to import the data, or vice-versa. However, you can transfer data in either direction between UNIX and Windows by mounting the UNIX VOB or file-system on your Windows machine and running both clearexport_sccs and clearimport on the Windows machine.

S-Files, G-Files, and P-Files

clearexport_sccs works directly with the structured SCCS s-files, which have the s. filename prefix. It does not process the g-files created with get and get -e commands. Be sure to check in such files with the delta command before running clearexport_sccs. clearexport_sccs issues warning messages when it encounters checked-out files, but it still processes them.

Other than issuing warning messages for checked-out files, clearexport_sccs ignores the p-files created by get -e.

If s-files are stored in SCCS (or sccs; case is not important) subdirectories, clearexport_sccs collapses the subdirectory level. For example, SCCS file ./proj/SCCS/s.main.c becomes element ./proj/main.c.

Multiple-Pass Export

You can process an SCCS file in several passes. For example, you can use clearexport_sccs to process major revision level 1, and use it again to process major revision level 2. On the subsequent passes, clearimport updates an existing element correctly if that ClearCase VOB element has not been modified in the interim.

SPECIAL CHARACTERS IN FILE NAMES

During import, clearimport invokes a shell to extract data from the datafile. clearimport can handle some, but not all, characters that are special to shells. Import fails for any file name that includes any of these characters:

`  '  "  <Tab>  [  ]  ?  *  %

For example:

Before running clearexport_sccs, rename any file whose name contains these characters.

NOTE: If you specify datafile-pname or source-name and any of the names include spaces, you must enclose the name in double quotes. For example:

> clearexport_sccs "src files"

VERSION TREE STRUCTURE AFTER CONVERSION

Revisions on the main branch of an SCCS file have two-digit identifiers (for example, 1.2). These revisions become versions on the main branch of the ClearCase element, as illustrated in Figure 6.

Figure 6 Conversion of SCCS Revisions

Note that the major revision substructure in the SCCS revision tree is lost in the translation-all the SCCS revisions become versions on the main branch. (But you can use the -V option to preserve this information in the form of attributes attached to the versions.)

Revisions on subbranches of an SCCS file have four-digit identifiers (for example, 1.2.1.5). These revisions become versions on subbranches of the ClearCase element, as illustrated in Figure 7.

Figure 7 Conversion of SCCS Subbranches

ClearCase branch types are created with three-digit names (1.2.1 in the example above). Thus, SCCS revision 1.2.1.3 becomes version 3 on branch 1.2.1.

Branches Off Branches

Although it is not illustrated in Figure 7,clearexport_sccs can handle SCCS files that include branches off branches. clearexport_sccs uses the information in the SCCS delta list to determine which SCCS versions are the predecessors of other versions, then uses an algorithm to determine the correct branching structure.

TRANSLATION FILE

An SCCS branch ID is a name for a particular branch of an SCCS file. clearexport_sccs translates the symbols to names of branch types. Suppose an SCCS symbol, rls_1.3_fixes, names a branch 3.5.1. clearexport_sccs exports a description of branch type rls_1.3_fixes, and clearimport creates a branch of that type at the ClearCase version created from SCCS revision 3.5.

You can enforce consistency of translation by using a translation file to control the names of ClearCase branches created from SCCS branches. If you name such a file using the -T option, clearexport_sccs uses it as follows:

• To look up each SCCS branch ID to see how to translate it to the name of a branch type. If a match is found, the branch ID is translated the same way.
• To record each translation of a new SCCS branch ID for use in future lookups.

The first time you use clearexport_sccs, use -T to create a new translation file. On subsequent invocations of clearexport_sccs, use -T again, specifying the same translation file for consistent name translation.

Syntax of Translation File

The translation file consists of one or more lines in the following form:

branch old-name new-name

For example, to rename the branch type pre_import_work to post_import_work and the branch type old_tests to obsolete_tests, the translation file contains the lines:

branch pre_import_work post_import_work
branch old_tests obsolete_tests

No blank lines are allowed in the file.

HANDLING OF OBJECTS THAT CANNOT BE EXPORTED

When clearexport_sccs encounters a file or directory that cannot be exported (for example, a file with format problems, or a broken symbolic link), it prints an error and continues. After creating the data file, the command prints a summary of the files and directories that could not be exported.

PERMISSIONS AND LOCKS

Permissions Checking: No special permissions required. Locks: No locks apply.

OPTIONS AND ARGUMENTS

HANDLING OF DIRECTORY ARGUMENTS.  Default: If you specify a directory as a source-name argument: (1) clearexport_sccs processes the files in that directory but ignores the contents of the subdirectories; (2) clearimport creates a directory element for source-name and for each of its subdirectories.

-r

clearexport_sccs descends recursively into all source-name arguments that are directories.

SELECTIVE CONVERSION OF FILES.  Default: clearexport_sccs processes all SCCS revisions it finds.

-s date-time

clearexport_sccs processes only SCCS revisions that have been modified since the time specified. Use this option for regular, incremental updating of an element from an SCCS file that is still under development. Be sure to specify a date-time that covers the entire period since the preceding update. In other situations, it is probably better to use -I instead of -s.

clearexport_sccs determines whether to process an SCCS archive by using the last-modified date/time of the archive. If this date/time is before the date-time you specify with -s, clearexport_sccs does not process any of the revisions in the archive. If the archive's date/time is after the date-time you specify, clearexport_sccs processes the following revisions:

NOTE: In an incremental updating situation, if you remove a branch from an SCCS revision, clearimport does not remove the branch from the ClearCase element.

Specify the time as follows:

date.time | date | time | now
where:

Specify time in 24-hour format, relative to the local time zone. If you omit the time, the default value is 00:00:00. If you omit date, the default is today. If you omit the century, year, or a specific date, the most recent one is used. Specify UTC if you want ClearCase to resolve the time to the same moment in time regardless of time zone. Use the plus (+) or minus (-) operator to specify a positive or negative offset to the UTC time. If you specify UTC without hour or minute offsets, Greenwich Mean Time (GMT) is used. (Dates before January 1, 1970 Universal Coordinated Time (UTC) are invalid.)

-I { now | date-time }

Processes important revisions only, but includes all revisions created since the specified time. A version is important if any of these conditions is true:

PRESERVATION OF SCCS-IDS AS ATTRIBUTES.  Default: clearexport_sccs does not attach attributes to versions exported from SCCS revisions.

-V

Attaches an attribute of type SCCS_ID to each newly created version. The string value of the attribute is the SCCS-ID of the exported SCCS revision. (clearimport creates attribute type SCCS_ID, if necessary.)

If you use the -s option with this option, clearimport attaches SCCS_ID attributes only to revisions created after the date-time you specified.

Each attribute requires about 1 KB of storage in the VOB database.

DIRECTORY FOR TEMPORARY FILES. Default: clearexport_sccs uses the value of the TMP environment variable as the directory for temporary files.

-t temp-dir-pname

Specifies an alternate directory for temporary files. This directory must already exist.

BRANCH NAME TRANSLATION.  Default: As described in the section VERSION TREE STRUCTURE AFTER CONVERSION, clearexport_sccs creates ClearCase branch names based on the SCCS revision IDs.

-T translation-file

Uses the specified translation file to control the mapping between SCCS branches and ClearCase branches. See also the TRANSLATION FILE.

STORAGE LOCATION OF DATAFILE.  Default: clearexport_sccs creates datafile cvt_data in the current working directory.

-o datafile-pname

Stores the datafile in the specified location. An error occurs if datafile already exists.

SPECIFYING FILES TO BE EXPORTED.  Default: clearexport_sccs processes the current working directory (equivalent to specifying "." as the source-name argument). If you specify a directory as a source-name argument: (1) clearexport_sccs processes the s-files in that directory but ignores the contents of the subdirectories; (2) clearimport creates a directory element for source-name and for each of its subdirectories (except one named SCCS or sccs).

source-name ...

One or more pathnames, specifying s-files and/or directories:

Each source-name must be a simple file or directory name. This enables clearimport to reliably access the source data. Specifying the parent directory (..) causes an error, as does any pathname that includes a backslash (\) character.

Thus, before entering this command, you should change to the directory where (or under which) the s-files to be exported reside. If the s-files reside in SCCS subdirectories, use the -r option to enable clearexport_sccs to find them.

EXAMPLES 

• Create a datafile for a single SCCS file.

c:\> clearexport_sccs s.myprogram.c

• Process three SCCS files in the current working directory and store the datafile in file cvt_include.

c:\> clearexport_sccs -o cvt_include s.bgr1.h s.bgr2.h s.bgr3.h

SEE ALSO

clearexport_*, clearimport, events_ccase, relocate