KSat/fsfw
15
4
Fork 0
forked from fsfw/fsfw
Code Issues Pull Requests 1 Releases Wiki Activity

doc update

Browse Source
This commit is contained in:
Robin Mueller 2022-04-11 16:44:20 +02:00
parent b2252bdc0b
commit 4f0669c574
No known key found for this signature in database
GPG Key ID: 11D4952C8CCEF814
3 changed files with 13 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CMakeLists.txt
View File

@ -10,7 +10,7 @@ set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake" ${CMAKE_MODULE_PATH})
set(FSFW_ETL_LIB_MAJOR_VERSION 20 CACHE STRING
"ETL library major version requirement"
)
set(FSFW_ETL_LIB_VERSION ${FSFW_ETL_LIB_MAJOR_VERSION}.26.0 CACHE STRING
set(FSFW_ETL_LIB_VERSION ${FSFW_ETL_LIB_MAJOR_VERSION}.27.2 CACHE STRING
"ETL library exact version requirement"
)
@ -106,11 +106,9 @@ if(FSFW_BUILD_UNITTESTS)
endif()
message(STATUS "Finding and/or providing ETL library")
# Check whether the user has already installed ETL first
# I think the version provisioning feature of CMake has not been implemented for the ETL library
# yet. Therefore we can not specify any (not even the major) version here and we have to rely
# on the user having installed the correct version for now
find_package(${FSFW_ETL_LIB_NAME} QUIET)
find_package(${FSFW_ETL_LIB_NAME} ${FSFW_ETL_LIB_MAJOR_VERSION} QUIET)
# Not installed, so use FetchContent to download and provide etl
if(NOT ${FSFW_ETL_LIB_NAME}_FOUND)
message(STATUS

11
README.md
View File

@ -56,9 +56,10 @@ information about the possible options.
The Embedded Template Library (etl) is a dependency of the FSFW which is automatically
installed and provided by the build system unless the correction version was installed.
The current recommended version can be found inside the fsfw `CMakeLists.txt` file or by using
`ccmake` and looking up the `FSFW_ETL_LIB_VERSION` variable.
`ccmake` and looking up the `FSFW_ETL_LIB_MAJOR_VERSION` variable.
You can install the ETL library like this:
You can install the ETL library like this. On Linux, it might be necessary to add `sudo` before
the install call:
```cpp
git clone https://github.com/ETLCPP/etl
@ -69,10 +70,8 @@ cmake ..
cmake --install .
```
Right now, the version provision feature by the ETL library has not been implemented
yet so `CMake` is unable to determine and check the major version of the ETL
library. You have to ensure that the ETL library has been installed with the
correct major version.
It is recommended to install `20.27.2` or newer for the package version handling of
ETL to work.
## Adding the library

11
docs/getting_started.rst
View File

@ -25,9 +25,10 @@ Prerequisites
The Embedded Template Library (etl) is a dependency of the FSFW which is automatically
installed and provided by the build system unless the correction version was installed.
The current recommended version can be found inside the fsfw ``CMakeLists.txt`` file or by using
``ccmake`` and looking up the ``FSFW_ETL_LIB_VERSION`` variable.
``ccmake`` and looking up the ``FSFW_ETL_LIB_MAJOR_VERSION`` variable.
You can install the ETL library like this:
You can install the ETL library like this. On Linux, it might be necessary to add ``sudo`` before
the install call:
.. code-block:: console
@ -38,10 +39,8 @@ You can install the ETL library like this:
cmake ..
cmake --install .
Right now, the version provision feature by the ETL library has not been implemented
yet so ``CMake`` is unable to determine and check the major version of the ETL
library. You have to ensure that the ETL library has been installed with the
correct major version.
It is recommended to install ``20.27.2`` or newer for the package version handling of
ETL to work.
Adding the library
-------------------