Specify building in Release with CMake in docs - #1095
Conversation
…ose for neXtSIM and apply Release build type.
Mikolaj-A-Kowalski
left a comment
There was a problem hiding this comment.
Just one comment, but I think it is good to go.
|
I also checked the Dockerfiles for CI and applied similar changes there in 681046d |
|
Are we sure of the URL for the XOIS? It seems that the Jul 1 scheduled job also failed with similar issue? |
|
The address seems correct, but the branch might not be, see: Downloading_and_compiling_the_XIOS_library I tried amending in cca91bf but it seems to still fail. Update: cannot ping , so I think server is down, can retry later. |
TomMelt
left a comment
There was a problem hiding this comment.
Perhaps we can discuss tomorrow. Overall happy with simplification and addition to docs. But I dont fully understand the dockerfile changes
|
|
||
| # Pre-fetch XIOS source code | ||
| RUN svn checkout http://forge.ipsl.fr/ioserver/svn/XIOS3/trunk /xios | ||
| RUN svn checkout http://forge.ipsl.fr/ioserver/svn/XIOS/trunk XIOS |
There was a problem hiding this comment.
quick question... why did you change back to xios2? I think @joewallwork moved us to XIOS3.
Is this a mistake?
There was a problem hiding this comment.
Also the install directory has been changed from /xios to effectively ./XIOS
There was a problem hiding this comment.
That was a change to follow the XIOS docs (linked above) after @Mikolaj-A-Kowalski queried whether we are using the correct url and command.
My intention was to drop if it didn't fix the issue which I can do now, given we seem to have established it's just the server being intermittent.
…ing (via configuration) in release mode.
d56a1a8 to
df00fbb
Compare
Specify building in Release with CMake in docs
Fixes #1094
Task List
Change Description
As discussed in #1094 installation docs do not specify adding a CMake Build Type flag for Release.
This can lead to new users naively building in debug which is orders of magnitude slower.
This PR adds the flag explicitly.
In addition I note that decomp is documented with CMake modern, whilst neXtSIM is CMake classic.
I took the opportunity to standardise these in 54284b5
If we would prefer to standardise all to Modern I can do that here.
Further I believe there is a small issue with decomp in that Release was not specified at configure time via
CMake_BUILD_TYPE.It was applied at build time via
--configbut I believe this is only for multi-config generators like VSCode andf Ninja, so would not have been applied for Makefiles.I am assuming users of this code are using a Makefile approach, but this should be confirmed by more experienced developers.
Test Description
No code changes, therefore no tests changes.
Documentation Impact
Installation docs are the target of the updates described above.
Other Details
None