Set Up SVN Source Control - MATLAB & Simulink (original) (raw)

You can use Subversion® (SVN) source control in MATLAB® to manage your files and collaborate with others. For more information, see Work with Files Under SVN in MATLAB.

Before using SVN, follow these steps to set it up for MATLAB:

Use Standard SVN Repository Structure

Create your repository with the standard tags,trunk, and branches folders, and check out files from trunk. The Subversion project recommends using this repository structure. For more information, see https://svn.apache.org/repos/asf/subversion/trunk/doc/user/svn-best-practices.html.

Register Binary Files with SVN

If you use third-party source control tools, you must register your MATLAB and Simulink® file extensions such as .mlx, .mat,.fig, .mlapp, .mdl,.slx, .mdlp, .slxp,.sldd, and .p as binary formats. Also register extensions for MEX files, such as .mexa64, .mexmaci64,.mexmaca64, and .mexw64. If you do not register the extensions, these tools can corrupt your files when you submit them by changing end-of-line characters, expanding tokens, substituting keywords, or attempting to automerge. Corruption can occur if you use the source control tools outside of MATLAB or if you try submitting files from MATLAB without first registering your file formats.

Also register other file extensions, such as .xlsx,.jpg, .pdf, and .docx, as binary formats to avoid corruption during the check-in operation.

You must register binary files if you use any version of SVN, including the built-in SVN integration provided by MATLAB. If you do not register your extensions as binary, SVN might add annotations to conflicted MATLAB files and attempt automerge. To avoid this problem when using SVN, register file extensions.

  1. Locate your SVN config file. Look for the file in these locations:
    • On Windows® –C:\Users\_`myusername`_\AppData\Roaming\Subversion\config or C:\Documents and Settings\_`myusername`_\Application Data\Subversion\config
    • On Linux® or macOS – ~/.subversion
  2. If you do not find an SVN config file, create a new one by following the steps in the Create SVN Config File section.
  3. If you find an existing SVN config file, you have previously installed SVN. Edit the config file by following the steps in the Update Existing SVN Config File section.

Create SVN Config File

  1. If you do not find an SVN config file, create a text file containing these lines:
    [miscellany]
    enable-auto-props = yes
    [auto-props]
    *.mlx = svn:mime-type=application/octet-stream
    *.mat = svn:mime-type=application/octet-stream
    *.fig = svn:mime-type=application/octet-stream
    *.mdl = svn:mime-type=application/octet-stream
    *.slx = svn:mime-type=application/octet-stream
    *.mlapp = svn:mime-type=application/octet-stream
    *.p = svn:mime-type=application/octet-stream
    *.mdlp = svn:mime-type=application/octet-stream
    *.slxp = svn:mime-type=application/octet-stream
    *.sldd = svn:mime-type=application/octet-stream
    *.slxc = svn:mime-type=application/octet-stream
    *.mlproj = svn:mime-type=application/octet-stream
    *.mldatx = svn:mime-type=application/octet-stream
    *.slreqx = svn:mime-type=application/octet-stream
    *.sfx = svn:mime-type=application/octet-stream
    *.sltx = svn:mime-type=application/octet-stream
  2. Check for other file types you use that you also need to register as binary to avoid corruption at check-in. Check for files such as MEX-files (.mexa64, .mexmaci64,.mexw64), .xlsx,.jpg, .pdf,.docx, etc. Add a line to theconfig file for each file type you need. Examples:
    *.mexa64 = svn:mime-type=application/octet-stream
    *.mexw64 = svn:mime-type=application/octet-stream
    *.mexmaci64 = svn:mime-type=application/octet-stream
    *.xlsx = svn:mime-type=application/octet-stream
    *.docx = svn:mime-type=application/octet-stream
    *.pdf = svn:mime-type=application/octet-stream
    *.jpg = svn:mime-type=application/octet-stream
    *.png = svn:mime-type=application/octet-stream
  3. Name the file config and save it in the appropriate location.
    • On Windows –C:\Users\_`myusername`_\AppData\Roaming\Subversion\config or C:\Documents and Settings\_`myusername`_\Application Data\Subversion\config
    • On Linux or macOS – ~/.subversion

After you create the SVN config file, SVN treats new files with these extensions as binary. If you already have binary files in repositories, see Register Files Already in Repositories.

Update Existing SVN Config File

If you find an existing SVNconfig file, you have previously installed SVN. Edit the config file to register files as binary.

  1. Edit the SVN config file in a text editor.
  2. Locate the [miscellany] section, and verify that this line enables auto-props withyes.
    Ensure that this line does not begin with a # character, which indicates that the line is commented. If the line begins with a# character, delete the character.
  3. Locate the [auto-props] section. Ensure that the[auto-props] section does not begin with a# character. If the section begins with a# character, delete the character.
  4. Add these lines at the end of the [auto-props] section:
    *.mlx = svn:mime-type=application/octet-stream
    *.mat = svn:mime-type=application/octet-stream
    *.fig = svn:mime-type=application/octet-stream
    *.mdl = svn:mime-type=application/octet-stream
    *.slx = svn:mime-type= application/octet-stream
    *.mlapp = svn:mime-type= application/octet-stream
    *.p = svn:mime-type=application/octet-stream
    *.mdlp = svn:mime-type=application/octet-stream
    *.slxp = svn:mime-type=application/octet-stream
    *.sldd = svn:mime-type=application/octet-stream
    *.slxc = svn:mime-type=application/octet-stream
    *.mlproj = svn:mime-type=application/octet-stream
    *.mldatx = svn:mime-type=application/octet-stream
    *.slreqx = svn:mime-type=application/octet-stream
    *.sfx = svn:mime-type=application/octet-stream
    *.sltx = svn:mime-type=application/octet-stream
    These lines prevent SVN from adding annotations to conflicted MATLAB and Simulink files and from attempting automerge.
  5. Check for other file types you use that you also need to register as binary to avoid corruption at check-in. Check for files such as MEX-files (.mexa64, .mexmaci64,.mexw64), .xlsx,.jpg, .pdf,.docx, etc. Add a line to theconfig file for each file type you use. For example, add these lines.
    *.mexa64 = svn:mime-type=application/octet-stream
    *.mexw64 = svn:mime-type=application/octet-stream
    *.mexmaci64 = svn:mime-type=application/octet-stream
    *.xlsx = svn:mime-type=application/octet-stream
    *.docx = svn:mime-type=application/octet-stream
    *.pdf = svn:mime-type=application/octet-stream
    *.jpg = svn:mime-type=application/octet-stream
    *.png = svn:mime-type=application/octet-stream
  6. Save the config file.

After you create or update the SVN config file, SVN treats new files as binary. If you already have files in repositories, register them as described in Register Files Already in Repositories.

Register Files Already in Repositories

Changing your SVN config file does not affect files already committed to an SVN repository. If an existing file is not registered as binary, use svn propset in command-line SVN to manually register the files as binary.

svn propset svn:mime-type application/octet-stream binaryfilename

Enforce Locking Files Before Editing

You can configure SVN to make files with specific extensions read-only. Users must place a lock on read-only files before editing them. When a file has a lock, other users know the file is being edited and you can avoid merge issues.

To enforce locking files, modify entries in the SVN config file. To locate your SVN config file, see Register Binary Files with SVN.

  1. To make files with an .m extension read-only, add a property to your SVN config file in the[auto-props] section. If there is no entry for files with an .m extension, add one with theneeds-lock property.
    If an entry exists, you can combine properties in any order, but multiple entries must be on a single line separated by semicolons.
  2. To make files with an .mlx extension read-only, add a property to your SVN config file in the[auto-props] section. Because you must register files with an .mlx extension as binary, there is an entry for the file type. Add the needs-lock property to the entry in any order on a single line and separated by a semicolon.
    *.mlx = svn:mime-type=application/octet-stream;svn:needs-lock=yes
  3. Recreate the working folder for the configuration to take effect.

After you enforce file locking, users must place a lock on a file before editing the file. For more information, see Get SVN File Locks.

Share a Subversion Repository

To share a subversion repository, set up a server using the Apache™ SVN module. For more information, see https://svnbook.red-bean.com/en/1.7/svn-book.html#svn.serverconfig.httpd.

Note

See Also

Topics