From d0f995c06782713fcbea6fca24423637fe55efcf Mon Sep 17 00:00:00 2001 From: Andrei Gramakov Date: Mon, 2 Dec 2019 07:48:28 +0100 Subject: [PATCH] doc: added a component-specific property description for FreeRTOS: ORIG_INCLUDE_PATH --- docs/en/api-reference/system/freertos_additions.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/en/api-reference/system/freertos_additions.rst b/docs/en/api-reference/system/freertos_additions.rst index 969cc2d87..1b0fc4e4b 100644 --- a/docs/en/api-reference/system/freertos_additions.rst +++ b/docs/en/api-reference/system/freertos_additions.rst @@ -14,6 +14,8 @@ entries of arbitrary lengths. :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. +:ref:`component-specific-properties`: Currently added only one component specific property `ORIG_INCLUDE_PATH`. + .. _ring-buffers: @@ -519,3 +521,13 @@ Hooks API Reference ------------------- .. 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"`.