Skip to content

Commit d0f995c

Browse files
author
Andrei Gramakov
committed
doc: added a component-specific property description for FreeRTOS: ORIG_INCLUDE_PATH
1 parent 738e9f7 commit d0f995c

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/en/api-reference/system/freertos_additions.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ entries of arbitrary lengths.
1414
:ref:`hooks`: ESP-IDF FreeRTOS hooks provides support for registering extra Idle and
1515
Tick hooks at run time. Moreover, the hooks can be asymmetric amongst both CPUs.
1616

17+
:ref:`component-specific-properties`: Currently added only one component specific property `ORIG_INCLUDE_PATH`.
18+
1719

1820
.. _ring-buffers:
1921

@@ -519,3 +521,13 @@ Hooks API Reference
519521
-------------------
520522

521523
.. include-build-file:: inc/esp_freertos_hooks.inc
524+
525+
526+
.. _component-specific-properties:
527+
528+
Component Specific Properties
529+
-----------------------------
530+
531+
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:
532+
533+
- `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"`.

0 commit comments

Comments
 (0)