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

Commit 4b0839b

Browse files
authored
Merge pull request #178 from mathworks/fix_issue_177
Add doc for MATLAB Axis
2 parents b8b66aa + 359fd5a commit 4b0839b

File tree

5 files changed

+18
-8
lines changed

5 files changed

+18
-8
lines changed

src/main/resources/com/mathworks/ci/MatlabInstallationAxis/config.jelly

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
</j:when>
1818
</j:choose>
1919

20-
<f:entry help="">
20+
<f:entry>
2121
<j:forEach var="installation" items="${descriptor.installations}">
2222
<f:checkbox name="values" json="${installation.name}" checked="${instance.values.contains(installation.name)}" title="${installation.name}" />
2323
<st:nbsp/>
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<div>
2+
<p>
3+
Use this list to add MATLAB versions as axis values to your matrix configuration. The list includes the names of all MATLAB versions that have been registered as a tool in Jenkins.<br>
4+
In each build iteration, the plugin prepends one of the selected versions to the PATH environment variable and invokes it to perform the build.
5+
</p>
6+
<p><br>
7+
<b>Note:</b> In multi-configuration projects, the values specified by <b>Use MATLAB version</b> take precedence over the values specified by the <b>MATLAB</b> axis.
8+
</p>
9+
</div>
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
<div>
22
<p>Specify the location of folders containing source code, relative to the project root folder. The specified folders and their subfolders are added to the top of the MATLAB search path. To generate a coverage report, MATLAB uses only the source code in the specified folders and their subfolders.</p>
3-
<p>Paste the source folder path in the <b>File path</b> box. To add more folders, click <b>Add folder</b>.</p>
3+
<p>Paste the source folder path in the <b>Folder path</b> box. To add more folders, click <b>Add folder</b>.</p>
44
</div>
Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
<div>
2-
Enter the full path to the MATLAB root folder, which is returned by the <i><b>matlabroot</b></i> function. The specified directory will be prepended to the PATH environment variable, and the specified MATLAB version will be used to perform the build.
3-
You must not leave this field blank if no MATLAB directory exists on the path. If you leave the field blank, then the system tries to use the MATLAB directory closest to the top of the system path. <br><br><br>Example:<br><br><i><b><u>Windows:</u></b></i><br> C:\Program Files\MATLAB\R2019a <br>
4-
<i><b><u>Linux:</u></b></i><br> /usr/local/MATLAB/R2019a <br>
5-
<i><b><u>Mac:</u></b></i><br> /Applications/MATLAB_R2019a.app <br>
2+
Enter the full path to the MATLAB root folder, which is returned by the <b>matlabroot</b> function. The plugin prepends the folder to the PATH environment variable and uses the specified MATLAB version to perform the build.
3+
You must not leave this box blank if no MATLAB folder exists on the path. If you leave it blank, the plugin attempts to use the topmost MATLAB folder on the system path.
4+
<br><br><br>Here are examples of the root folder path on different platforms:<br><br><b>Windows:</b><br> C:\Program Files\MATLAB\R2020b <br>
5+
<b>Linux:</b><br> /usr/local/MATLAB/R2020b <br>
6+
<b>macOS:</b><br> /Applications/MATLAB_R2020b.app <br>
67
<p>
78
<b>Note:</b> If the job runs on a remote agent, you must specify the full path to MATLAB root folder on the remote agent.</p>
8-
</div>
9+
</div>

src/main/resources/com/mathworks/ci/UseMatlabVersionBuildWrapper/help.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<div>
22
<p>
33
Use this list to specify the MATLAB version for the build. The plugin prepends your specified MATLAB to the PATH environment variable and uses it to perform the build. <br>
4-
The list includes the names of all MATLAB versions that have been registered as a tool in <u>Jenkins</u>. Select one of the tools, or select <b>Custom</b> if you want to specify a different version. When you select <b>Custom</b>, you must enter the full path to the desired MATLAB root folder in the <b>MATLAB root</b> box.
4+
The list includes the names of all MATLAB versions that have been registered as a tool in Jenkins. Select one of the tools, or select <b>Custom</b> if you want to specify a different version. When you select <b>Custom</b>, you must enter the full path to the desired MATLAB root folder in the <b>MATLAB root</b> box.
55
</p>
66
<p><br>
77
<b>Note:</b> In multi-configuration projects, the value specified by <b>Use MATLAB version</b> takes precedence over the values specified by the <b>MATLAB</b> axis.

0 commit comments

Comments
 (0)