RADE

Source Code Manager

adl_co

Acquiring files

Quick Reference

Abstract

The adl_co command acquires (checks-out) one, or more, files in the current image of the current workspace for modification purposes in an official acquisition mode.

Synopsis
Usage
Options
Examples
References

Synopsis

adl_co file... [-shared |-force_excl | -excl] [-no_check] [-h | -help | -?]

Usage

There are several types of acquisition, depending on whether other people are allowed to simultaneously modify files you are currently working on:

Non exclusive check-out: the file can be acquired and modified by another user, in another workspace.

Non exclusive forced check-out: an exclusivity has been set on the file by another workspace and this exclusivity has been forced. This option is only used for critical cases. The file can be acquired and modified in parallel, in the workspace.

Exclusive check-out: no other workspace is allowed to modify the file before the new version has been retrieved (through a synchronization, collect).

Remarks:

If the file is already acquired in private mode ([3] adl_mk_priv command) in the same image, it keeps the same contents but the private acquisition is transformed into an official acquisition.
If the file is already acquired in private mode ([3] adl_mk_priv command) in another image of the same workspace, the command fails.
If the file is already officially acquired in another image of the same workspace, the command fails.

Rules options:

If the option -shared or -force_excl is defined, or if -excl isn't defined and if the file is a text file, the check-out will be shared.
If the option -excl is defined, or if neither -shared nor -force_excl is defined and if the file is a binary file, the check-out will be exclusive.
A shared check-out allows parallel modifications of the file content. The resulting contents might have to be merged.
An exclusive check-out prevents any parallel modification: in another workspace, a user should wait until he gets your file content before he may modify it.
You can't check-out an element if any user has run an exclusive check-out and if you don't get its file content. If you can't wait (critical cases), you can use the option -force_excl in order to break this exclusivity ; notice that the file contents would have to be merged.
You can exclusively check-out an element only if you get the last file content of the element in your workspace tree, and if no other file content in your workspace tree would be merged with it (no parallel modification).

To list all the acquired file of a given workspace, run the [1] adl_ls_co command.
To delete the acquisition on a file, run the [2] adl_unco command.

[Top]

Options

adl_co accepts the following options:

`-h\|-help\|-?`	Help of the command
`file ...`	Path(es) of the file(s) element(s) to check-out
`-shared`	Shared check-out
`-force_excl`	Shared check-out with exclusivity break (critical cases)
`-excl`	Exclusive check-out
`-no_check`	No check that the file has been modified out of SCM scope

[Top]

Examples

Acquire a file "MyFile" in the directory "src" of the framework "MyFw" of the workspace "MyWs":

adl_ch_ws MyWs  
adl_co MyFw/src/MyFile

or

adl_ch_ws MyWs  
cd MyFw/src  
adl_co MyFile

Acquire a file "MyFile" in an exclusive mode:

adl_ch_ws MyWs

adl_co -excl MyFw/src/MyFile

Acquire a file "MyFile" without any check:

adl_ch_ws MyWs

adl_co -no_check MyFw/src/MyFile

Acquire a file "MyFile" in a shared mode:

adl_ch_ws MyWs

adl_co -shared MyFw/src/MyFile

Acquire a file "MyFile" in a shared mode, with exclusivity break:

adl_ch_ws My_Ws

adl_co -force_excl My_fw/Toto

[Top]

References

[1]
[2]
[3]

adl_ls_co: Listing the acquired objects
adl_unco: Unacquiring an object
adl_mk_priv: Acquiring file in a private mode

[Top]

History

Version: 1 [Mar 2001]

Document created

[Top]