Skip to content

Commit b80720c

Browse files
Fixed typos
Signed-off-by: Philip Windecker <philip.windecker@avenyr.de>
1 parent c2271b8 commit b80720c

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

doc/setup/installing_prerequisites.adoc

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,27 @@ endif::[]
77

88
== Prerequisites
99

10-
* You have installed _cmake_ (version 3.10.2 or higher).
11-
* You must have super user privileges.
10+
* You have installed _cmake_ (version 3.10.2 or higher)
11+
* You must have superuser privileges
1212

13-
Static linking is the recommended way to package OSI FMUs for sharing with others to be integrated in a co-simulation: They should have minimal external dependencies, in order to ensure maximum portability.
14-
Fo other use cases like first trials to get started with OSI, dynamic linking could be an option, as well.
13+
Static linking is the recommended way to package OSI FMUs for sharing with others to be integrated in a co-simulation: They should have minimal external dependencies in order to ensure maximum portability.
14+
For other use cases like first trials to get started with OSI, dynamic linking could be an option as well.
1515

1616
== Windows
1717

1818
**Dynamic Linking (NOT RECOMMENDED)**
1919

20-
Since on windows symbols are not exported per default it can be kind of annoying to deal with this during _protobuf_ header generation (see for example https://groups.google.com/g/protobuf/c/PDR1bqRazts).
21-
So basically thats one more reason to use static linking.
20+
Since on Windows symbols are not exported per default, it can be kind of annoying to deal with this during _protobuf_ header generation (see for example https://groups.google.com/g/protobuf/c/PDR1bqRazts).
21+
That is an important reason to use static linking.
2222

2323
**Static Linking**
2424

2525
Static linking might require to manually build _protobuf_.
26-
Its important to notice that on windows you can also specify how to link against the C runtime.
27-
Basically this can be set in CMake e.g. https://cmake.org/cmake/help/latest/prop_tgt/MSVC_RUNTIME_LIBRARY.html
26+
It is important to notice that on Windows you can also specify how to link against the C runtime.
27+
Basically, this can be set in CMake, e.g. https://cmake.org/cmake/help/latest/prop_tgt/MSVC_RUNTIME_LIBRARY.html
2828

29-
Therefore, it could make sense to still dynamically link against the C Runtime when statically linking _protobuf_ / OSI.
30-
(This is important e.g. when building shared libraries, since a static C runtime will create an isolated heap for your dll, which can lead to segfaults depending on what you expose on your public interfaces.)
29+
Therefore, it could make sense to still dynamically link against the C Runtime when statically linking _protobuf_ / OSI.
30+
(This is important e.g. when building shared libraries, since a static C runtime will create an isolated heap for your dll, which can lead to segfaults depending on what you expose on your public interfaces.)
3131

3232
The easiest way to achieve static linking on Windows without setting all the stuff manually in Cmake and building _protobuf_ is to actually use vcpkg:
3333

@@ -39,7 +39,7 @@ vcpkg install --triplet=x64-windows-static-md protobuf
3939

4040
**Build:**
4141

42-
For the cmake configuration we can directly specify our vcpkg installation:
42+
For the cmake configuration, we can directly specify our vcpkg installation:
4343
----
4444
cmake .. -DVCPKG_TARGET_TRIPLET=x64-windows-static-md -DCMAKE_TOOLCHAIN_FILE=C:/path/to/vcpkg/scripts/buildsystems/vcpkg.cmake -A x64
4545
cmake --build . --config Release
@@ -49,18 +49,19 @@ cmake --build . --config Release
4949

5050
**Dynamic linking (NOT RECOMMENDED)**
5151

52-
As already mentioned, shared linking is possible on linux, but NOT RECOMMENDED.
53-
However, for dynamic linking, install _protobuf_ (version 3.0.0 or higher) with apt:
52+
As already mentioned, shared linking is possible on Linux, but NOT RECOMMENDED.
53+
However, for dynamic linking install _protobuf_ (version 3.0.0 or higher) with apt:
5454
----
5555
sudo apt-get install libprotobuf-dev protobuf-compiler
5656
----
57-
and in the CMakeLists of the OSI project, `LINK_WITH_SHARED_OSI` has to be enabled.
57+
In the CMakeLists of the OSI project, `LINK_WITH_SHARED_OSI` has to be enabled.
5858

5959
**Static linking**
6060

6161
A common error here is to just install _protobuf_ with apt and link against it.
6262
This means that your OSI is build statically but still linking dynamically against _protobuf_.
63-
Here, again either _protobuf_ has to build statically from source or some solution e.g. vcpkg needs to be utilized. We recommend the following (as in the README of the OSI project):
63+
Here, again either _protobuf_ has to build statically from source or some solution e.g. vcpkg needs to be utilized.
64+
We recommend the following (as in the README of the OSI project):
6465

6566
Install _protobuf_ (version 3.0.0 or higher) from source with `CXXFLAGS="-fPIC"` to allow static linking of your OSI FMUs (replace <version> with preferred release):
6667
----

0 commit comments

Comments
 (0)