clearfsimport
Converts file system objects
to element versions
SYNOPSIS
- UNIX
only:
- clearfsimport [ –preview ]
[ –follow ] [ –recurse ] [ –rmname ]
- [–comment comment ]
[ –mklabel label ] [ –nsetevent ]
[ –identical ]
[ –master ] [ –unco ] source-name [
. . . ] target-VOB-directory
- Windows
only:
- clearfsimport [ –preview ]
[ –recurse ] [ –rmname ]
- [ –comment comment ]
[ –mklabel label ] [ –nsetevent ]
[ –identical ]
[ –master ] [ –unco ]
[ –downcase ] source-name [
. . . ] target-VOB-directory
DESCRIPTION
The clearfsimport command
reads the specified file system source objects and places them in the target
VOB. This command uses magic files to determine which element type to use
for each element created (see the cc.magic reference
page). The source and target directories may not be the same; to create an
element from a view-private object that already resides in the target directory,
use mkelem.
RESTRICTIONS
Identities
You must
be root (UNIX) or the VOB owner to run clearfsimport unless
you invoke it with the -nsetevent option.
Locks
If it encounters
a VOB lock while trying to write data during an import operation, clearfsimport pauses
and retries the operation every 60 seconds until it succeeds.
Mastership
(Replicated
VOBs only) Your current replica must master the branch types, branches, elements,
and type objects involved in the import. With the –master option,
the importer can create a new element and its main branch
even if the main branch is not mastered by your current
replica. The –master option also allows auto-make-branch
during element creation; mastership of newly created branches is assigned
to the current replica. When you specify the –master option,
you must be able to check out the parent directory of the new element.
Working Directory
Because
Windows prohibits renaming a directory that is in use, you cannot run clearfsimport in a snapshot view on Windows if the
current working directory is also the target-VOB-directory.
OPTIONS AND ARGUMENTS
Previewing the Results
- Default
- No preview.
- –preview
- Previews the import, listing all elements
that the import would add or change, as well as any checkouts that would conflict
with imports, but does not import anything.
Handling of UNIX Symbolic Links
- Default
- Processes each UNIX symbolic link
as a VOB symbolic link with the same link text.
- –follow
- Processes the object to which a UNIX
symbolic link points, instead of importing the link itself into the VOB.
Handling of Directory Arguments
- Default
- If a source-name argument
names a directory to be imported, an element version is created for the directory
and for each file, directory, or UNIX symbolic link residing at the top level
of the directory.
- –recurse
- Descends recursively into all source-name arguments
that are directories.
Handling of Existing VOB Directories
- Default
- Existing VOB directories that are
not present in the sources to be imported are left as is.
- –rmname
- For all source-name arguments
that are directories, performs an rmname operation
on elements that are already in the VOB but are not present in the source
directory. If used in combination with -recurse, performs
this rmname operation in all directories
traversed. If used in combination with -downcase, performs
the downcase operation before looking for
matching names in the VOB.
Comments
- Default
- created by clearfsimport
- –comment comment
- Attaches the specified comment instead
of the default comment to each element version checked in to the VOB.
Labeling
- Default
- No labeling.
- –mklabel label
- Attaches the specified label instance
to each element version checked in. If the corresponding label type does not
exist, it is created. If the label is already attached to an existing element
version, it is moved.
Event Records
- Default
- Historical information associated
with the sources is preserved.
- –nsetevent
- Specifies that event records and historical
information for new elements and element versions show the user who executed clearfsimport and
the date of execution, not the original data associated with the sources.
This option creates element versions that are newer than the original sources;
thus, the clearfsimport operation is not restartable after
you have invoked it with this option.
Creation of Identical Successor Versions
- Default
- Element versions that are identical
to their predecessors in the source are not created.
- –identical
- Creates a new version of an element—even
if it is identical to its predecessor—if the source has a more recent
date than that of the version in the VOB.
Branch Mastership
- Default
- The main branch of the element is
mastered by the replica that masters the branch's type.
- –master
- Assigns mastership of the main branch
of the element to the VOB replica at which you execute this command.
Handling of Existing Checked-Out Elements
- Default
- When clearfsimport encounters
a checked-out element that exists in the target VOB and corresponds to a source
to be imported, it prints an error and continues.
- –unco
- If a checked-out file element that
corresponds to a source file to be imported exists in the target VOB, an uncheckout operation is executed on the element
and the corresponding view-private file is retained with a suffix of .keep.
The import operation then checks out the element again and checks in the imported
version.
Handling of Case of Imported Elements
- Default
- Case preserving.
- –downcase
- Changes names of imported elements
to lowercase.
Note: When importing files from a
UNIX host into a VOB on a Windows NT host, clearfsimport may
be unable to operate correctly on files and directories that have mixed-case
names. For example, if a mixed-case name is specified on the command line, clearfsimport creates
the element name as specified, even when the form of the source name is different.
Consistent use of -downcase can help avoid these problems.
If you specify-downcase for an initial import from UNIX to
Windows NT, specify it on any subsequent imports into the same VOB directories.
Specifying the Source
- Default
- None.
- source-name [. . .]
- Flat files, directories, and UNIX
symbolic links to be imported to the VOB. You can specify pathnames or use
wildcards as described in wildcards_ccase.
For each pathname, the leaf of the
pathname is imported into the target VOB. For example, /usr/src/lib/foo.c is
imported into the VOB /vobs/mylib as /vobs/mylib/foo.c or
into the VOB /bigvob as /bigvob/foo.c.
For each file, an element version
is imported. If a corresponding version of the file exists in the target VOB
and is checked out, clearfsimport prints and error and
continues unless the -unco option was specified. A summary
of import failures due to checked-out elements is printed at the completion
of the import operation.
For each directory, versions are created
for all files and UNIX symbolic links it contains. Also created is a directory
element with one version for the directory and each of its subdirectories.
Checked-out VOB directories that correspond to source directories to be imported
are reused.
Specifying the Target VOB
- Default
- None.
- target-VOB-directory
- The VOB directory to which the sources
are to be imported. This directory may not be the same as the directory from
which the sources are being imported.
EXAMPLES
- Preview
a VOB—/vobs/projectx/src—that is to be populated
with the contents of /usr/src/projectx. Recursively descend
all directories encountered and follow UNIX symbolic links to the target objects.