RADE

Source Code Manager

adl_mk_elem

Creating elements

Quick Reference

Abstract

The adl_mk_elem command creates one or more element(s) in the current image of the current workspace.

Synopsis
Usage
Naming rules
Options
Examples
References

Synopsis

Usage

This command creates in the current image of the current workspace one, or more, files already existing in the directories of the current image.
The "adl_mk_elem src/fic.cpp" command first runs an [2] "mk_dir src” if the src directory does not exist, then “mk_elem fic.cpp”.

This command takes as argument an existing file: it is not possible to declare in SCM a file that has no physical existence.

You can precise the type of the file to be created. If no type is chosen, the command determines the file type according to the suffix of the file.
Run [3] adl_ls_type command in order to list all the available file's types.

File type determines:

If the content of the file is text or binary.
If the file is executable or not for UNIX.

There are four basics types:

txt text file, not executable
sh text file, executable for Unix
bin binary file, not executable
exe binary file, executable for Unix

If the file has no suffix, it is necessary to specify one of those four basics types.

(2) If you use the option -wr in order to check-out automatically the new element instead of running the [4] adl_co command:

If the option -shared 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 -shared isn't 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, users should wait until they get your file content before being allowed to modify it.

After running the adl_mk_elem command in an image, you cannot launch any modification command (creation, move, rename, delete, or modification of contents) in another image of the same workspace, till this image has been refreshed.

Naming rules

The basic naming rules are:

Maximum length: 128 characters, including the extension.
Some file names are not allowed directly below a framework: PublicInterfaces, ProtectedInterfaces, PrivateInterfaces, IdentityCard.
Suffix is optional.
A file with a .h type cannot be created twice in a tree (requested by mkmk), except for the IdentityCard.h file. This is the default mode. You can force the creation, using a specific option.

For more information on the naming rules, see the [5] naming rules document.

[Top]

Options

adl_mk_elem accepts the following options:

`-h\|-help\|-?`	Help of the command
`file_name ...`	Path(es) of the file(s) element(s) to create
`-type`	Type of the file
`-force`	Ignore elements and other SCM objects whose names conflict with the one to create
`-wr`	Check-out the element(s)
`-shared`	Shared check-out
`-excl`	Exclusive check-out

Examples

Creation of the "MyNewElem" element in the "MyFw" framework under the "MyWsDev" workspace:

adl_ch_ws MyWsDev
adl_mk_elem MyFw/MyMod/src/MyNewElem.c

or

adl_ch_ws MyWsDev
cd MyFw/MyMod/src
adl_mk_elem MyNewElem.c

Creation of the "MyNewElem" element under the "MyFw" framework, using an old element name, giving the type of the file:

adl_ch_ws MyWsDev
adl_mk_elem MyFw/MyMod/src/MyNewElem -type doc -force

or

adl_ch_ws MyWsDev
cd MyFw/MyMod/src
adl_mk_elem MyNewElem -type doc -force

[Top]

References

[1]
[2]
[3]
[4]
[5]

adl_mk_data: creating data
adl_mk_dir: creating directories
adl_ls_type: listing files types
adl_co: checking-out files
naming rules document

[Top]

History

Version: 1 [Mar 2001]

Document created

[Top]