alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'feature/freertos_authentic_includes_docs' into 'master'

Browse Source 
docs: Added ORIG_INCLUDE_PATH description to the doc

See merge request espressif/esp-idf!6889
This commit is contained in:
Krzysztof Budzynski 2020-06-08 18:24:57 +08:00
commit d3a400c159
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"`.