Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

doc: added a component-specific property description for FreeRTOS: ORIG_INCLUDE_PATH

Browse source
This commit is contained in:
Andrei Gramakov 2019-12-02 07:48:28 +01:00
parent 738e9f76fd
commit d0f995c067
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/en/api-reference/system/freertos_additions.rst
View file

@ -14,6 +14,8 @@ entries of arbitrary lengths.
:ref:`hooks`: ESP-IDF FreeRTOS hooks provides support for registering extra Idle and :ref:`hooks`: ESP-IDF FreeRTOS hooks provides support for registering extra Idle and
Tick hooks at run time. Moreover, the hooks can be asymmetric amongst both CPUs. Tick hooks at run time. Moreover, the hooks can be asymmetric amongst both CPUs.
:ref:`component-specific-properties`: Currently added only one component specific property `ORIG_INCLUDE_PATH`.
.. _ring-buffers: .. _ring-buffers:
@ -519,3 +521,13 @@ Hooks API Reference
------------------- -------------------
.. include-build-file:: inc/esp_freertos_hooks.inc .. include-build-file:: inc/esp_freertos_hooks.inc
.. _component-specific-properties:
Component Specific Properties
-----------------------------
Besides standart component variables that could be gotten with basic cmake build properties FreeRTOS component also provides an arguments (only one so far) for simpler integration with other modules:
- `ORIG_INCLUDE_PATH` - contains an absolute path to freertos root include folder. Thus instead of `#include "freertos/FreeRTOS.h"` you can refer to headers directly: `#include "FreeRTOS.h"`.