Improved content description of binaries and resources dirs (#1822) #1832
Conversation
…#1822) Clearly define which files should go the binaries and resources dir of the FMU which when these dirs must be unpacked by the FMU importer.
docs/2_5_fmu_distribution.adoc
Outdated
| @@ -84,19 +87,20 @@ The header files `fmi3PlatformTypes.h`, `fmi3FunctionTypes.h` and `fmi3Functions | |||
|
|
|||
| ===== Directory `binaries` [[binaries-directory]] | |||
|
|
|||
| A binary FMU must contain the binary files for all supported platforms in this folder. | |||
| A binary FMU must contain, for each supported platform, the shared library `<modelIdentifier>.{dll|dylib|so}` and all files which are needed to load this shared library | |||
There was a problem hiding this comment.
An FMU may also ship with static libraries.
|
Webmeeting: @t-sommer : I will come up with proposals to simplify the wording. Could also be backported to FMI 2.0.x |
Co-authored-by: Pierre R. Mai <pmai@pmsf.de>
| To use the binaries of a specific platform, all items in that platform-specific binary folder must be unpacked at the same location as the binary `<modelIdentifier>.{dll|dylib|so}`. | ||
| This is needed since the shared library may search for other files, needed during library load time, relative to its own file location. |
There was a problem hiding this comment.
This reasoning should not be normative.
|
|
||
| ====== FMUs with static libraries [[binaries-directory-static]] | ||
|
|
||
| A static library binary FMU must contain, for each supported platform and ABI, the static library `<modelIdentifier>.{a|lib}` and all files which are needed to link with this static library |
There was a problem hiding this comment.
Requiring "all files which are needed to link with this static library" to be contained in the FMU would render any FMU illegal that has external dependencies (caused by the static library).
|
|
||
| A static library binary FMU must contain, for each supported platform and ABI, the static library `<modelIdentifier>.{a|lib}` and all files which are needed to link with this static library | ||
| in the corresponding platform-specific binary folder. | ||
| These binary files may go into an ABI specific subdirectory, see <<platform-tupe-definition>> also for linking instructions. |
There was a problem hiding this comment.
This folder must not be a subdirectory of the platform binary directory but the binaries directory. Also, we should not allow spreading libraries and dependencies across multiple folders.
There was a problem hiding this comment.
IMHO, we should have a concise set of rules for the naming and availability at runtime in the spec and move all the reasoning and explanations to the implementers guide.
|
All: Markus dropped off our planet. Any change we want to be made, we must now make. @t-sommer : will you take over? You seem most interested... |
|
We should decide whether to proceed with this PR or close it, if the changes are not considered helpful. |
|
FMI Design Meeting: Christian: I will create a new PR |
|
Superseded by #1849 |
Clearly define which files should go the binaries and resources dir of the FMU which when these dirs must be unpacked by the FMU importer.