checkout (MATLAB Functions)

Check files out of source control system (UNIX only)

Graphical Interface

As an alternative to the checkout function, use Source Control -> Check Out in the File menu of the Editor/Debugger, Simulink, or Stateflow, or in the context menu of the Current Directory browser.

Syntax

checkout('filename')
checkout({'filename1','filename2', ...})
checkout('filename','option','value', ...)

Description

checkout('filename') checks out the file named filename from the source control system. Use the full path for filename and include the file extension. The file can be open or closed when you use checkout.

checkout({'filename1','filename2', ...}) checks out the files named filename1 through filenamen from the source control system. Use the full paths for the files and include the file extensions.

checkout('filename','option','value', ...) provides additional checkout options. For multiple filenames, use an array of strings instead of filename, that is, {'filename1','filename2', ...}. Options apply to all filenames. The option and value arguments are shown in the following table.

option Argument
value Argument
Purpose

'force'
'on'
The checkout is forced, even if you already have the file checked out. This is effectively an undocheckout followed by a checkout.

'force'
'off' (default)
Prevents you from checking out the file if you already have it checked out.

'lock'
'on' (default)
The checkout gets the file, allows you to write to it, and locks the file so that access to the file for others is read only.

'lock'
'off'
The checkout gets a read-only version of the file, allowing another user to check out the file for updating. You do not have to check the file in after checking it out with this option.

'revision'
'version_num'
Checks out the specified revision of the file.

option Argument	value Argument	Purpose
`'force'`	`'on'`	The checkout is forced, even if you already have the file checked out. This is effectively an `undocheckout` followed by a `checkout`.
`'force'`	`'off' (default)`	Prevents you from checking out the file if you already have it checked out.
`'lock'`	`'on' (default)`	The checkout gets the file, allows you to write to it, and locks the file so that access to the file for others is read only.
`'lock'`	`'off'`	The checkout gets a read-only version of the file, allowing another user to check out the file for updating. You do not have to check the file in after checking it out with this option.
`'revision'`	`'version_num'`	Checks out the specified revision of the file.

If you end the MATLAB session, the file remains checked out. You can check in the file from within MATLAB during a later session, or directly from your source control system.

Examples

Check Out a File

Typing

```
checkout('/myserver/mymfiles/clock.m')
```

checks out the file /myserver/mymfiles/clock.m from the source control system.

Check Out Multiple Files

Typing

checkout({'/myserver/mymfiles/clock.m',...
'/myserver/mymfiles/calendar.m'})

checks out /matlab/mymfiles/clock.m and
/matlab/mymfiles/calendar.m from the source control system.

Force a Checkout, Even If File Is Already Checked Out

Typing

checkout('/myserver/mymfiles/clock.m','force','on')

checks out /matlab/mymfiles/clock.m even if clock.m is already checked out to you.

Check Out Specified Revision of File

Typing

checkout('/matlab/mymfiles/clock.m','revision','1.1')

checks out revision 1.1 of clock.m.

For Windows platforms, use verctrl.

checkin chol