Skip to content

Commit f80d1a2

Browse files
jkey-engjkey-eng
committed
mailbox-requirements: Merge Cleanup
Updated to incorporate fix for StrictDoc migration changes (changing [SECTION] to [[SECTION]]) Cleaned up requirement numbering based on external changes. signed-off-by: Joel Key <[email protected]>
1 parent 04fe679 commit f80d1a2

File tree

3 files changed

+44
-43
lines changed

3 files changed

+44
-43
lines changed

‎docs/software_requirements/index.sdoc‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,5 @@ FILE: lifos.sdoc
7979
[DOCUMENT_FROM_FILE]
8080
FILE: fifos.sdoc
8181

82-
[DOCUMENT_FROM_FILE]
83-
FILE: mailbox.sdoc
84-
8582
[DOCUMENT_FROM_FILE]
8683
FILE: mailboxes.sdoc

‎docs/software_requirements/mailboxes.sdoc‎

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[DOCUMENT]
22
TITLE: Mailboxes
3-
REQ_PREFIX: ZEP-SRS-22-
3+
REQ_PREFIX: ZEP-SRS-25-
44

55
[GRAMMAR]
66
IMPORT_FROM_FILE: software_requirements.sgra
@@ -11,7 +11,7 @@ SPDX-License-Identifier: Apache-2.0
1111
<<<
1212

1313
[REQUIREMENT]
14-
UID: ZEP-SRS-22-1
14+
UID: ZEP-SRS-25-1
1515
STATUS: Draft
1616
TYPE: Functional
1717
COMPONENT: Mailboxes
@@ -24,10 +24,10 @@ As a Zephyr RTOS developer, I want to be able to initialize a mailbox instance s
2424
<<<
2525
RELATIONS:
2626
- TYPE: Parent
27-
VALUE: ZEP-SYRS-22
27+
VALUE: ZEP-SYRS-25
2828

2929
[REQUIREMENT]
30-
UID: ZEP-SRS-22-2
30+
UID: ZEP-SRS-25-2
3131
STATUS: Draft
3232
TYPE: Functional
3333
COMPONENT: Mailboxes
@@ -40,10 +40,10 @@ As a Zephyr RTOS developer, I want to be able to statically define and initializ
4040
<<<
4141
RELATIONS:
4242
- TYPE: Parent
43-
VALUE: ZEP-SYRS-22
43+
VALUE: ZEP-SYRS-25
4444

4545
[REQUIREMENT]
46-
UID: ZEP-SRS-22-4
46+
UID: ZEP-SRS-25-3
4747
STATUS: Draft
4848
TYPE: Functional
4949
COMPONENT: Mailboxes
@@ -56,10 +56,10 @@ As a Zephyr RTOS developer, I want to be able to send messages of different size
5656
<<<
5757
RELATIONS:
5858
- TYPE: Parent
59-
VALUE: ZEP-SYRS-22
59+
VALUE: ZEP-SYRS-25
6060

6161
[REQUIREMENT]
62-
UID: ZEP-SRS-22-6
62+
UID: ZEP-SRS-25-4
6363
STATUS: Draft
6464
TYPE: Functional
6565
COMPONENT: Mailboxes
@@ -69,10 +69,10 @@ The Zephyr RTOS shall handle the data transfer between mailbox objects of the se
6969
<<<
7070
RELATIONS:
7171
- TYPE: Parent
72-
VALUE: ZEP-SYRS-22
72+
VALUE: ZEP-SYRS-25
7373

7474
[REQUIREMENT]
75-
UID: ZEP-SRS-22-8
75+
UID: ZEP-SRS-25-5
7676
STATUS: Draft
7777
TYPE: Functional
7878
COMPONENT: Mailboxes
@@ -85,10 +85,10 @@ As a Zephyr RTOS developer, I want to be able to send a message and wait for it
8585
<<<
8686
RELATIONS:
8787
- TYPE: Parent
88-
VALUE: ZEP-SYRS-22
88+
VALUE: ZEP-SYRS-25
8989

9090
[REQUIREMENT]
91-
UID: ZEP-SRS-22-10
91+
UID: ZEP-SRS-25-6
9292
STATUS: Draft
9393
TYPE: Functional
9494
COMPONENT: Mailboxes
@@ -101,10 +101,10 @@ As a Zephyr RTOS developer, I want to be able to limit how long my thread waits
101101
<<<
102102
RELATIONS:
103103
- TYPE: Parent
104-
VALUE: ZEP-SYRS-22
104+
VALUE: ZEP-SYRS-25
105105

106106
[REQUIREMENT]
107-
UID: ZEP-SRS-22-11
107+
UID: ZEP-SRS-25-7
108108
STATUS: Draft
109109
TYPE: Functional
110110
COMPONENT: Mailboxes
@@ -117,10 +117,10 @@ As a Zephyr RTOS developer, I want to be able to send a message without waiting
117117
<<<
118118
RELATIONS:
119119
- TYPE: Parent
120-
VALUE: ZEP-SYRS-22
120+
VALUE: ZEP-SYRS-25
121121

122122
[REQUIREMENT]
123-
UID: ZEP-SRS-22-13
123+
UID: ZEP-SRS-25-8
124124
STATUS: Draft
125125
TYPE: Functional
126126
COMPONENT: Mailboxes
@@ -133,10 +133,10 @@ As a Zephyr RTOS developer, I want to be notified when my asynchronously sent me
133133
<<<
134134
RELATIONS:
135135
- TYPE: Parent
136-
VALUE: ZEP-SYRS-22
136+
VALUE: ZEP-SYRS-25
137137

138138
[REQUIREMENT]
139-
UID: ZEP-SRS-22-14
139+
UID: ZEP-SRS-25-9
140140
STATUS: Draft
141141
TYPE: Functional
142142
COMPONENT: Mailboxes
@@ -149,10 +149,10 @@ As a Zephyr RTOS developer, I want to be able to receive messages from other thr
149149
<<<
150150
RELATIONS:
151151
- TYPE: Parent
152-
VALUE: ZEP-SYRS-22
152+
VALUE: ZEP-SYRS-25
153153

154154
[REQUIREMENT]
155-
UID: ZEP-SRS-22-15
155+
UID: ZEP-SRS-25-10
156156
STATUS: Draft
157157
TYPE: Functional
158158
COMPONENT: Mailboxes
@@ -165,10 +165,10 @@ As a Zephyr RTOS developer, I want to be able to extract message data into my bu
165165
<<<
166166
RELATIONS:
167167
- TYPE: Parent
168-
VALUE: ZEP-SYRS-22
168+
VALUE: ZEP-SYRS-25
169169

170170
[REQUIREMENT]
171-
UID: ZEP-SRS-22-16
171+
UID: ZEP-SRS-25-11
172172
STATUS: Draft
173173
TYPE: Functional
174174
COMPONENT: Mailboxes
@@ -178,10 +178,10 @@ When a receiving thread requests a message via a mailbox object and no message i
178178
<<<
179179
RELATIONS:
180180
- TYPE: Parent
181-
VALUE: ZEP-SYRS-22
181+
VALUE: ZEP-SYRS-25
182182

183183
[REQUIREMENT]
184-
UID: ZEP-SRS-22-17
184+
UID: ZEP-SRS-25-12
185185
STATUS: Draft
186186
TYPE: Functional
187187
COMPONENT: Mailboxes
@@ -194,10 +194,10 @@ As a Zephyr RTOS developer, I want to be able to limit how long my thread waits
194194
<<<
195195
RELATIONS:
196196
- TYPE: Parent
197-
VALUE: ZEP-SYRS-22
197+
VALUE: ZEP-SYRS-25
198198

199199
[REQUIREMENT]
200-
UID: ZEP-SRS-22-18
200+
UID: ZEP-SRS-25-13
201201
STATUS: Draft
202202
TYPE: Functional
203203
COMPONENT: Mailboxes
@@ -210,10 +210,10 @@ As a Zephyr RTOS developer, I want to be able to identify the source or destinat
210210
<<<
211211
RELATIONS:
212212
- TYPE: Parent
213-
VALUE: ZEP-SYRS-22
213+
VALUE: ZEP-SYRS-25
214214

215215
[REQUIREMENT]
216-
UID: ZEP-SRS-22-20
216+
UID: ZEP-SRS-25-14
217217
STATUS: Draft
218218
TYPE: Functional
219219
COMPONENT: Mailboxes
@@ -226,10 +226,10 @@ As a Zephyr RTOS developer, I want message delivery to respect thread priorities
226226
<<<
227227
RELATIONS:
228228
- TYPE: Parent
229-
VALUE: ZEP-SYRS-22
229+
VALUE: ZEP-SYRS-25
230230

231231
[REQUIREMENT]
232-
UID: ZEP-SRS-22-21
232+
UID: ZEP-SRS-25-15
233233
STATUS: Draft
234234
TYPE: Functional
235235
COMPONENT: Mailboxes
@@ -239,10 +239,10 @@ When multiple threads of equal priority are waiting on an empty mailbox object,
239239
<<<
240240
RELATIONS:
241241
- TYPE: Parent
242-
VALUE: ZEP-SYRS-22
242+
VALUE: ZEP-SYRS-25
243243

244244
[REQUIREMENT]
245-
UID: ZEP-SRS-22-22
245+
UID: ZEP-SRS-25-16
246246
STATUS: Draft
247247
TYPE: Functional
248248
COMPONENT: Mailboxes
@@ -252,10 +252,10 @@ When multiple messages are available in the send queue from the same sender, the
252252
<<<
253253
RELATIONS:
254254
- TYPE: Parent
255-
VALUE: ZEP-SYRS-22
255+
VALUE: ZEP-SYRS-25
256256

257257
[REQUIREMENT]
258-
UID: ZEP-SRS-22-23
258+
UID: ZEP-SRS-25-17
259259
STATUS: Draft
260260
TYPE: Functional
261261
COMPONENT: Mailboxes
@@ -268,10 +268,10 @@ As a Zephyr RTOS developer, I want to be able to create as many mailboxes as my
268268
<<<
269269
RELATIONS:
270270
- TYPE: Parent
271-
VALUE: ZEP-SYRS-22
271+
VALUE: ZEP-SYRS-25
272272

273273
[REQUIREMENT]
274-
UID: ZEP-SRS-22-24
274+
UID: ZEP-SRS-25-18
275275
STATUS: Draft
276276
TYPE: Functional
277277
COMPONENT: Mailboxes
@@ -284,4 +284,4 @@ As a Zephyr RTOS developer, I want the system to validate my inputs and return e
284284
<<<
285285
RELATIONS:
286286
- TYPE: Parent
287-
VALUE: ZEP-SYRS-22
287+
VALUE: ZEP-SYRS-25

‎docs/system_requirements/index.sdoc‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -353,14 +353,18 @@ The Zephyr RTOS shall implement FIFOs which can be used to pass data between thr
353353
<<<
354354

355355
[[/SECTION]]
356-
[/SECTION]
357356

358-
[SECTION]
357+
[[SECTION]]
359358
TITLE: Mailboxes
359+
360+
[REQUIREMENT]
361+
UID: ZEP-SYRS-25
362+
STATUS: Draft
363+
TYPE: Functional
360364
COMPONENT: Mailboxes
361365
TITLE: Mailboxes
362366
STATEMENT: >>>
363367
The Zephyr RTOS shall provide a framework to pass messages of arbitrary size between threads.
364368
<<<
365369

366-
[/SECTION]
370+
[[/SECTION]]

0 commit comments

Comments
 (0)