Skip to content

Commit 717137f

Browse files
author
korbinian90
committed
fix the automatic compile MEX section
1 parent 1db5105 commit 717137f

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

docs/development/compilation/index.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,16 @@ Platform-specific throubleshooting is available with the links above. We list he
2424

2525
!!! info "How is the recompilation triggered?"
2626

27-
If new c files or changes are pushed to main, the [compile MEX](https://github.com/spm/spm/actions/workflows/compile_mex.yml) action will automatically run and recompile all MEX files. In can also be triggered manually, which works for a any branch.
27+
If new `.c, .cpp, .h or .hpp` files or changes of those are pushed to `main`, the [compile MEX](https://github.com/spm/spm/actions/workflows/compile_mex.yml) action will automatically run and recompile all MEX files. In can also be triggered manually, which works for a any branch.
2828

29-
The compiled MEX files will be available as zip a file under the [compile MEX](https://github.com/spm/spm/actions/workflows/compile_mex.yml) action by selecting the corresponding run of the action and downloading the spm-mex-all.zip file. It contains compiled MEX files for Windows, Linux, MacOS (Intel) and MacOS (Apple Silicon).
29+
The compiled MEX files will be available as zip a file under the [compile MEX](https://github.com/spm/spm/actions/workflows/compile_mex.yml) action by selecting the corresponding run of the action and downloading the `spm-mex-all.zip` file. It contains compiled MEX files for Windows, Linux, MacOS (Intel) and MacOS (Apple Silicon).
3030

3131
The suggested steps after changing or adding new c code is:
32-
1. Confirm that the [automatic tests](https://github.com/spm/spm/actions/workflows/matlab.yml) still succeed
33-
2. Download the [automatically compiled MEX files](https://github.com/spm/spm/actions/workflows/compile_mex.yml)
34-
3. Manually add the MEX files of the corresponding change to the SPM repository (.mexa64, .mexmaca64, .mexmaci64, .mexw64)
32+
33+
1. Confirm that the [automatic tests](https://github.com/spm/spm/actions/workflows/matlab.yml) still succeed
34+
35+
2. Download the [automatically compiled MEX files](https://github.com/spm/spm/actions/workflows/compile_mex.yml)
36+
37+
3. Manually add the MEX files of the corresponding change to the SPM repository (.mexa64, .mexmaca64, .mexmaci64, .mexw64)
3538

3639
Note: Currently, the action doesn't compile the external c dependencies. This is because of a problem of compiling the fieldtrip dependency on windows.

0 commit comments

Comments
 (0)