Documentation Center

  • Trials
  • Product Updates

checkout

Check files out of source control system (UNIX platforms)

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 file names, use an array of strings instead of filename, that is, {'filename1','filename2', ...}. Options apply to all file names. 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.

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

Examples

Check Out a File

Check out the file /myserver/myfiles/clock.m from the source control system:

checkout('/myserver/myfiles/clock.m')

Check Out Multiple Files

Check out /matlab/myfiles/clock.m and /matlab/myfiles/calendar.m from the source control system:

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

Force a Checkout, Even If File Is Already Checked Out

Check out /matlab/myfiles/clock.m even if clock.m is already checked out to you:

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

Check Out Specified Revision of File

Check out revision 1.1 of clock.m:

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

See Also

| | | |

Was this topic helpful?