pw_thread_freertos: Expand comment to help when debugging linker errors

Change-Id: Ie9919f4aad342a153f280582677fc04af48f346b Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/213669 Reviewed-by: Ted Pudlik <[email protected]> Commit-Queue: Auto-Submit <[email protected]> Lint: Lint 🤖 <[email protected]> Pigweed-Auto-Submit: Wyatt Hepler <[email protected]> Presubmit-Verified: CQ Bot Account <[email protected]>
google · Jun 4, 2024 · 80a5042 · 80a5042
1 parent 9bed7bf
commit 80a5042
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/pw_thread_freertos/util.cc b/pw_thread_freertos/util.cc
@@ -24,6 +24,11 @@
 // The externed symbols below are all internal FreeRTOS kernel variables from
 // FreeRTOS/Source/tasks.c needed in order to iterate through all of the threads
 // from interrupts which the native APIs do not permit.
+//
+// NOTE: FreeRTOS declares these symbols as `static`, so they are not normally
+// accessible outside of their translation unit. The `static` keyword must be
+// removed by setting `pw_third_party_freertos_DISABLE_TASKS_STATICS` in the
+// builds. See https://pigweed.dev/pw_thread_freertos/#thread-iteration-backend.
 
 extern "C" PRIVILEGED_DATA volatile BaseType_t xSchedulerRunning;