RADE |
Source Code Manager |
HandbookMain commands for daily work |
| Quick Reference | ||
AbstractThis article is intended for developers and people getting started with SCM. The reader will find here how to set up his environment to access the SCM commands and a brief description on the most useful commands and topics. Note that all commands or options are not given here, please refer to the "Command reference" page to get them [1]. We advice you to add a bookmark to this page or to print it. |
| Purpose | Commands | Parameter(s) |
|---|---|---|
| Get a command usage | command_name | -h or -help or -? |
| Set environment with Unix (*) | Open a shell window: . tck_init tck_profile TCK |
Tool Configuration Key |
| Set environment with Windows (*) | Open a command window: tck_init tck_profile TCK |
Tool Configuration Key |
| List defined workspace trees | adl_ls_tree | |
| List defined workspaces | adl_ls_ws | [-tree tree_name] |
| Create a workspace | adl_mk_ws (see also adl_mk_image) |
ws_name -dir ws_root_diretory -parent_ws ws_name |
| Select current workspace | adl_ch_ws | ws_name [-image image_name | -no_image] |
| Display workspace status | adl_ds_ws | [ws_name] |
(*) Please ask your administrator for the exact location of the tck_init profile.
| Purpose | Commands | Parameter(s) |
|---|---|---|
| Create a source/test/education framework | adl_mk_fw | framework_name (with suffix = "none"/.tst/.edu) |
| Create a code module | cd framework adl_mk_mod |
module_name |
| Create a data module | cd framework adl_mk_data |
module_name Ex: CNext, CNext.specifics_UNIX, data.d, ... |
| Create a documentation module | cd framework.edu adl_mk_data |
module_name Ex: module.doc |
| Create a file(*) | adl_mk_elem | {file_name} |
| Work on an existing component (Get a managed copy) |
adl_attach | {framework_name} [-mod] | {module_name} |
| Finish working on a component | adl_detach | {framework_name | module_name} |
| Check a workspace's file tree | adl_chk | [{framework_name}] |
(*) Users can create their files as usual but they must be recognized by the Workspace Manager, this is the purpose of the adl_mk_elem command.
| Purpose | Commands | Parameter(s) |
|---|---|---|
| Edit a file for delivery (*) - current image | adl_co | {file_name} [-excl] |
| Edit a file for debug purpose - current image | adl_mk_priv | {file_name} |
| Undo a adl_mk_priv command -current image | adl_rm_priv | {file_name} | -all |
| Undo a adl_co command - current image | adl_unco | {file_name} |
| Remove a file - current image | adl_rm | {file_name} |
| Move/rename a file - current image | adl_mv | file_name target_file_name | target_directory |
| Save checked-out files in database - current image | adl_ci | -all |
| Deliver modifications to parent workspace | adl_promote | |
| Simulate delivery | adl_promote | -simul |
| Undo the last adl_promote command | adl_rm_promo | |
| Synchronize with parent workspace | adl_sync | [-wr] |
(*) Even the file is present in your file system, you must check-out it to let SCM be aware about it.
| Purpose | Commands | Parameter(s) |
|---|---|---|
| List promotions requested by child workspaces | adl_ls_req | [ws_name] |
| Cancel promotion request(s) from child workspace(s) | adl_rm_req | {ws_name} |
| Get modifications from son workspaces | adl_collect | [{child_ws_name}] |
| Make available to child workspaces what have been collected before | adl_publish | [-label string] |
| Purpose | Commands | Parameter(s) |
|---|---|---|
| Create NT file system (image) for an existing Unix workspace | adl_mk_image | [image_name] [-ws ws_name] -dir \\machine\share_name\ws_NT_root_directory |
| Create Unix file system (image) for an existing NT workspace | adl_mk_image | [image_name] [-ws ws_name] -dir ws_unix_root_directory |
| Finish working on one platform and get your modifications on the other platform | adl_ci -alladl_refresh | Any command which makes a snapshot of your workspace can be used instead of adl_ci: adl_photo, adl_promote, adl_sync, ... |
| Purpose | Commands | Parameter(s) |
|---|---|---|
| Change location of root directory on Unix platform | adl_set_image_dir | ws_name -dir new_image_root_directory(*) |
| Change location of root directory on NT platform | adl_set_image_dir | ws_name -dir new_image_root_directory(*) (UNC format: //machine/share_name/...) |
(*) If data have been moved outside SCM control the command will recognize data, otherwize they will be projected into the new location, leaving the old location unchanged.
| [1] | User Command reference |
|
[Top]
|
|
| Version: 2 [June 2001] | Add links on the command's reference guide |
| Version: 1 [Apr 2000] | Document created |
|
[Top]
|
|
Copyright © 2000, Dassault Systèmes. All rights reserved.