Changeset d4a68940 in OpenModelica

Timestamp:

2020-10-21T14:04:18+02:00 (3 years ago)

Author:

Mahder Gebremedhin <mahder.gebremedhin@…>

Children:

d36146f

Parents:

a7fdcec

git-author:

Mahder Gebremedhin <mahder.gebremedhin@…> (10/19/20 12:01:13)

git-committer:

Mahder Gebremedhin <mahder.gebremedhin@…> (10/21/20 14:04:18)

Message:

[cmake] Add a custom install target 'install_omc'.

• This target builds and installs just omc. It is provided just for convenience to allow people to use something similar to what they are used to do , that is issue 'make install_omc', instead of having to run CMake's separate installation script.

Location:

OMCompiler

Files:

• Compiler/CMakeLists.txt (modified) (1 diff)
• README.cmake.md (modified) (3 diffs)

OMCompiler/Compiler/CMakeLists.txt

@@ -215 +215 @@
             DESTINATION ${CMAKE_INSTALL_LIBDIR}/omc
             COMPONENT compiler)
+
+
+# This is a convenience target to install omc. We are used to issuing 'make install' to install
+# components. CMake uses a separate install script to perform installations. This custom command
+# runs that cmake script so that you can just write 'make install' (for makefile generators)
+# or 'cmake --build <b_dir> --target install_omc' in the general case.
+add_custom_target(install_omc
+                  DEPENDS omc
+                  COMMAND ${CMAKE_COMMAND} cmake -DCOMPONENT=compiler -P cmake_install.cmake
+                  COMMENT "Installing omc."
+                  )

OMCompiler/README.cmake.md

@@ -8 +8 @@
 However, this does not mean that you will need CMake > 3.14 to compile and use OpenModelica as you do now. You should **still be able to compile OpenModelica using the current Makefile based and/or auto-tools based build system** that we are using at the moment even if you have CMake 2.6.
 
-# How to build
+# Usage
 **NOTE**: **_This does not yet support bootstrapping AND it also needs an omc with an UPDATED scripting API from this branch itself. This means, after you switch to this branch, you will have to **COMPILE omc ONCE** with the build method that you are currently using. Afterwards you can use the omc generated by this for further MetaModelica compilations._**
 
+## Build
 It is pretty straightforward cmake stuff.
 
@@ -28 +29 @@
 # omc will be generated in <build_dir>/Compiler/
 $ <build_dir>/Compiler/omc --help
+```
 
-# Install the files if you want
-$ cmake -DCOMPONENT=compiler -P cmake_install.cmake # to just install omc
+If you are on Linux like systems omc will check if it is in a folder whose path includes `/bin` or `/lib`. If it is not, it will tell you to update your OPENMODELICAHOME env variable.  Instead, you can just INSTALL the files as shown below or copy or move the generated omc into a folder called <something>/bin for now.
+
+# Install
+
+CMake uses a separate script (cmake_install.cmake) to perform installation. Since we are used to issuing 'make install' by default, CMake
+provides an specific built-in 'install' target. However, this target implies a **full build and full install**. That is you have no control on which parts you want to install. If this is what you want to do you can use that.
+
+If you are working on just omc and do not need the whole set of *simulation runtime* libraries built and installed, there is a custom target `install_omc` provided which will build and install what is needed to run omc.
+
+```
+# Build and Install just omc
+# $ make install_omc # For makefile generators
+# $ cmake --build <build_dir> --target install_omc # Generic usage.
+# $ cmake -DCOMPONENT=compiler -P cmake_install.cmake # The equivalent cmake_install invocation
+
+# Build and Install everything
 # $ make install # NOTE: This will first build everything. Not just omc.
-# $ cmake -P cmake_install.cmake # to install everything that is built
+# $ cmake --build <build_dir> --target install # Generic usage.
+# $ cmake -P cmake_install.cmake # The equivalent cmake_install invocation
 
 # omc will be installed in <install_dir>/bin/
@@ -38 +55 @@
 ```
 
-
-**NOTE**: _if you are on Linux like systems omc will check if it is in a folder whose path includes `/bin` or `/lib`. If it is not, it will tell you to update your OPENMODELICAHOME env variable.  Instead, you can just INSTALL the files as shown above or copy or move the generated omc into a folder called <something>/bin for now._
 
 ###### Installation can be buggy. It will be improved.