Show TOC Start of Content Area

Background documentation EDIT  Locate the document in its SAP Library structure

Use

Checks out a versioned object (file or folder) for edit. Each check-out is done in the context of an activity. The check-in of changes is always done by checking in the activity and not by checking in individual checked-out objects.

Syntax

Syntax

EDIT [[-a activityName] [-dn] [-rDepth]] <folderItemPath>

Arguments

 

[-a activityName]

If specified, the files will be checked out in the given activity. If the activity is not specified, the default activity for the workspace is used. If the specified activity does not exist, it will be created.

[-dn]

Specified if the name of the activity given is the display name and is not the actual name. This is only in case you want to use an existing activity.

[-rDepth]

If this option is specified and one of the path(s) is a folder then the items under the folder will be edited recursively until the depth specified (number).

<Example>

edit folderItemPath -r10

There should not be any spaces between the option and the number.

<folderItemPath>

Path to the folder where the file to be edited is located. The folder item path can be local or remote.

Description

Checks out the specified folder items for editing. Takes the path (local or remote) as an argument. Wild characters are accepted.

Example

Checking Out a File Using the Activity Display Name

...

To check out a file named a.java from the current folder in an activity with the display name “improved performance by factor of 10”, execute:

edit a.java –a “improved performance by factor of 10” –dn

Checking Out a Folder With Content Using the Activity Display Name

...

To check out a folder named abc including all its content up to infinite depth, in the activity with the display name “refactored the code”, execute:

edit abc –a “refactored the code” –dn –r

Here, the –r switch stands for “recursively”: Check-out for edit all content of the folder named abc up to infinite depth.

Checking Out a File From the Current Workspace and Folder in the Default Activity

...

To check out a file named b.java from the current folder using the default activity for the current workspace, execute:

edit b.java

End of Content Area