Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

uxTaskGetSystemState example in latest docs with IDF 5.1.2 does not compile (IDFGH-11707) #12814

Closed
3 tasks done
avrono opened this issue Dec 16, 2023 · 4 comments
Closed
3 tasks done
Labels
Resolution: Done Issue is done internally Status: Done Issue is done internally

Comments

@avrono
Copy link

avrono commented Dec 16, 2023

Answers checklist.

  • I have read the documentation ESP-IDF Programming Guide and the issue is not addressed there.
  • I have updated my IDF branch (master or release) to the latest version and checked that the issue is present there.
  • I have searched the issue tracker for a similar issue and not found a similar issue.

General issue report

https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/system/freertos_idf.html#_CPPv420uxTaskGetSystemStatePC12TaskStatus_tK11UBaseType_tPC27configRUN_TIME_COUNTER_TYPE

Code given in the above link results in a compile error even when configUSE_TRACE_FACILITY is enabled

error: unknown type name 'configRUN_TIME_COUNTER_TYPE'

Adding configGENERATE_RUN_TIME_STATS does not change the compile error either

According to https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/system/freertos_idf.html#_CPPv427ulTaskGetIdleRunTimeCounterv

configGENERATE_RUN_TIME_STATS + configUSE_STATS_FORMATTING_FUNCTIONS + INCLUDE_xTaskGetIdleTaskHandle must all be enabled for these functions to be available. However there is no obvious way to enable INCLUDE_xTaskGetIdleTaskHandle

@espressif-bot espressif-bot added the Status: Opened Issue is new label Dec 16, 2023
@github-actions github-actions bot changed the title uxTaskGetSystemState example in latest docs with IDF 5.1.2 does not compile uxTaskGetSystemState example in latest docs with IDF 5.1.2 does not compile (IDFGH-11707) Dec 16, 2023
@igrr
Copy link
Member

igrr commented Dec 16, 2023

configRUN_TIME_COUNTER_TYPE was only introduced recently, so the new example won't work as is with an older version of IDF. In general, try the examples bundled with the version of IDF you are using.

@avrono
Copy link
Author

avrono commented Dec 18, 2023

@igrr the documentation refers to the latest 5.1.2 which is the version I am running. Please advise ...

@igrr
Copy link
Member

igrr commented Dec 18, 2023

That's not the case, latest docs (i.e. https://docs.espressif.com/projects/esp-idf/en/latest/) are for the master branch. Please take a look here for instructions on finding the docs for your version: https://docs.espressif.com/projects/esp-idf/en/latest/esp32/versions.html#releases.

(Github also labels the most recent stable release as "Latest" on the release page, the Readthedocs docs URL for the latest stable release is https://docs.espressif.com/projects/esp-idf/en/stable/ — which at the time of writing points to 5.1.2 docs.)

@avrono
Copy link
Author

avrono commented Dec 18, 2023

My Mistake, thanks for the help.

@avrono avrono closed this as completed Dec 18, 2023
@espressif-bot espressif-bot added Status: Done Issue is done internally Resolution: Done Issue is done internally and removed Status: Opened Issue is new labels Dec 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Resolution: Done Issue is done internally Status: Done Issue is done internally
Projects
None yet
Development

No branches or pull requests

3 participants