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

Add Queue Requirements #76

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

simhein
Copy link
Collaborator

@simhein simhein commented Jul 2, 2024

Add Queue requirements on system and software level.

closes #21

@simhein simhein added the Requirements Requirements work label Jul 2, 2024
@simhein simhein requested a review from a team July 2, 2024 13:35
COMPONENT: Queues
TITLE: Queue data structure
STATEMENT: >>>
The Zephyr RTOS shall implement a queue data structure to hold data items.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As formulated here this is somehow a truism. What is the intention of this requirement?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is true that requirement makes no sense at this point, I will remove it. The intention was to make the data item more detailed and highlighted but if I would have done this it would have been more of a design item.

Copy link

@nicpappler nicpappler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mainly have two questions to get clarified and one typo. Nothing major.

COMPONENT: Queues
TITLE: Queue get item
STATEMENT: >>>
The Zephyr RTOS shall provide a mechanism to get a data item from a queue.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To me the "to get a data item" is not fully unambiguous - does this mean "to read", "to obtain and remove", "to read and then remove", "to remove" ? I have no better expression to suggest, though. Would be ok for me, if the majority here says the meaning of "to get" is clear in this context.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

corrected it to "get and remove"

COMPONENT: Queues
TITLE: Queue get item timeout
STATEMENT: >>>
When a timout for the get mechanism to get a data item is configured, the zephyr RTOS shall wait

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When a timout for the get mechanism to get a data item is configured, the zephyr RTOS shall wait
When a timout for the get mechanism to get a data item is configured, the Zephyr RTOS shall wait

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

corrected

COMPONENT: Queues
TITLE: Queue add list
STATEMENT: >>>
The Zephyr RTOS shall provide a mechanism to a complete list of data items to a queue.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand this requirement. To me it seems a word is missing here.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There was something missing indeed. Rephrased the requirement and the one which belongs to this one.

Add the new section queues to the system requirements.
Add new requirements for queues on system level.

Signed-off-by: Simon Hein <[email protected]>
Add new software requirements for queues.
and update the index.sdoc file to include the new requirements file.

Signed-off-by: Simon Hein <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Requirements Requirements work
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

Queue Requirements
3 participants