Skip to content

docs(queue): clarify pcTail marker comment - #1471

Open
katrinagui wants to merge 1 commit into
FreeRTOS:mainfrom
katrinagui:docs/fix-queue-tail-comment
Open

docs(queue): clarify pcTail marker comment#1471
katrinagui wants to merge 1 commit into
FreeRTOS:mainfrom
katrinagui:docs/fix-queue-tail-comment

Conversation

@katrinagui

Copy link
Copy Markdown

Description

Clarify the pcTail member comment. The queue allocates exactly
uxQueueLength * uxItemSize bytes and sets pcTail immediately after
that storage area, so it is a one-past-the-end marker rather than an
extra allocated byte.

No runtime behavior changes.

Test Steps

  • git diff --check
  • verified the queue allocation size and pcTail assignment in queue.c

Checklist:

  • I have tested my changes. No regression in existing tests.
  • I have modified and/or added unit-tests to cover the code changes in this Pull Request.

Unit tests are not applicable because this is a comment-only change.

Related Issue

N/A

By submitting this pull request, I confirm that you can use, modify, copy,
and redistribute this contribution, under the terms of your choice.

@sonarqubecloud

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant