Skip to content
This repository was archived by the owner on Mar 27, 2025. It is now read-only.

Commit 015af57

Browse files
authored
Update CONFIGDOC.md
1 parent cf24263 commit 015af57

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

CONFIGDOC.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
You can use the Jenkins™ plugin for MATLAB® in freestyle and multi-configuration projects. This guide demonstrates how to run MATLAB code on Jenkins, considering a Microsoft® Windows® platform.
22

3-
- [Add MATLAB to System Path](#add-matlab-to-system-path)
3+
- [Use MATLAB for Build](#use-matlab-for-build)
44
- [Specify Build Steps](#specify-build-steps)
55
- [Run MATLAB Tests](#run-matlab-tests)
66
- [Run MATLAB Command](#run-matlab-command)
77
- [Set Up Freestyle Project](#set-up-freestyle-project)
88
- [Set Up Multi-Configuration Project](#set-up-multi-configuration-project)
99

10-
## Add MATLAB to System Path
10+
## Use MATLAB for Build
1111
Once you install the plugin on Jenkins, the **Use MATLAB version** checkbox appears in the **Build Environment** section of the project configuration window.
1212

1313
![matlab_path](https://user-images.githubusercontent.com/48831250/76883191-1c528b00-6852-11ea-9242-7d143f8a5c46.png)
1414

15-
Select the **Use MATLAB version** checkbox to specify the full path to the MATLAB root folder that should be used for the build. The specified directory in the **MATLAB root** box is prepended to the PATH environment variable, and the matlab.exe file in the bin subdirectory is used to perform the build. You must not leave the **MATLAB root** box blank if no MATLAB directory exists on the path. If you do not select the checkbox or if you leave the text box blank, then the system tries to use the MATLAB directory closest to the top of the system path.
15+
Select the **Use MATLAB version** checkbox to specify the full path to the MATLAB root folder that should be used for the build. The information in the **MATLAB root** box enables the plugin to prepend MATLAB to the PATH environment variable of the build agent.
16+
17+
If the build agent already has your desired MATLAB on the path, then you are not required to select the **Use MATLAB version** checkbox. When the checkbox is clear, the plugin uses the MATLAB directory closest to the top of the path. The build fails if the plugin cannot find MATLAB on the path.
1618

1719
## Specify Build Steps
1820
When you set up the **Build** section of the project configuration window, the plugin provides you with the **Run MATLAB Tests** and **Run MATLAB Command** build steps.
@@ -67,9 +69,7 @@ You can define several axes in the **Configuration Matrix** section. For example
6769

6870
![axis_version_testtag](https://user-images.githubusercontent.com/48831250/76800736-aa733680-67aa-11ea-86a7-a984d5795e11.png)
6971

70-
2) In the **Build Environment** section, select **Use MATLAB version** and then specify the locations where MATLAB is installed using the user-defined axis name. (You can skip this step if MATLAB has already been added to the path on the build agents.)
71-
72-
In this example, **$VERSION** in the **MATLAB root** box will be replaced by one axis value per build iteration.
72+
2) In the **Build Environment** section, select **Use MATLAB version** and then specify the locations where MATLAB is installed using the user-defined axis name. In this example, **$VERSION** in the **MATLAB root** box will be replaced by one axis value per build iteration.
7373

7474
![build_environment_matrix](https://user-images.githubusercontent.com/48831250/76800665-87488700-67aa-11ea-9dbd-3c3ab518afa7.png)
7575

0 commit comments

Comments
 (0)