Skip to content

Commit d837025

Browse files
committed
Upgrade to the new SDoc syntax: [SECTION] -> [[SECTION]]
As of the version 0.9.1, StrictDoc has switched to a new syntax for defining SECTIONs. From now on, all sections must be defined as `[[SECTION]]` instead of `[SECTION]`. The rationale for the migration is explained in the related GitHub ticket: [Migration: SDoc model: Merge Section, Node, Composite Node into just Node #2193](strictdoc-project/strictdoc#2193) **IMPORTANT:** When this PR is reviewed and merged, all existing PRs should be updated to only have [[SECTION]] tags instead of [SECTION]. See also the migration guide for further reference: https://strictdoc.readthedocs.io/en/stable/stable/docs/strictdoc_01_user_guide.html#SECTION-UG-NODE-MIGRATION **StrictDoc 0.9.1 version is needed for this changeset to work.** Signed-off-by: Stanislav Pankevich [email protected]
1 parent 71d6558 commit d837025

File tree

5 files changed

+36
-15
lines changed

5 files changed

+36
-15
lines changed

docs/software_requirements/software_requirements.sgra

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
[GRAMMAR]
22
ELEMENTS:
3+
- TAG: SECTION
4+
PROPERTIES:
5+
IS_COMPOSITE: True
6+
FIELDS:
7+
- TITLE: UID
8+
TYPE: String
9+
REQUIRED: False
10+
- TITLE: TITLE
11+
TYPE: String
12+
REQUIRED: True
313
- TAG: REQUIREMENT
414
FIELDS:
515
- TITLE: UID

docs/software_requirements/thread_scheduling.sdoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ STATEMENT: >>>
1010
SPDX-License-Identifier: Apache-2.0
1111
<<<
1212

13-
[SECTION]
13+
[[SECTION]]
1414
TITLE: Thread Scheduling
1515

1616
[REQUIREMENT]
@@ -49,9 +49,9 @@ USER_STORY: >>>
4949
As a Zephyr RTOS user I want Zephyr OS to provide synchronization mechanisms between the CPU cores and the access to common resources.
5050
<<<
5151

52-
[/SECTION]
52+
[[/SECTION]]
5353

54-
[SECTION]
54+
[[SECTION]]
5555
TITLE: Thread Scheduling
5656

5757
[REQUIREMENT]
@@ -161,4 +161,4 @@ USER_STORY: >>>
161161
As a Zephyr RTOS user, I want to be able to configure my RTOS in the way, that the CPU resources are shared evenly among executed threads of the same priority.
162162
<<<
163163

164-
[/SECTION]
164+
[[/SECTION]]

docs/system_requirements/index.sdoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ USER_STORY: >>>
165165
As a Zephyr RTOS user I want to be able to control the power mode of the MCU and its peripherals to take advantage of the hardware features and to be able to implement low power or battery driven long life applications.
166166
<<<
167167

168-
[SECTION]
168+
[[SECTION]]
169169
TITLE: Multi core and SMP
170170

171171
[REQUIREMENT]
@@ -194,9 +194,9 @@ USER_STORY: >>>
194194
As a Zephyr RTOS user, I want to be able to control which thread will run on which CPU.
195195
<<<
196196

197-
[/SECTION]
197+
[[/SECTION]]
198198

199-
[SECTION]
199+
[[SECTION]]
200200
TITLE: Thread Synchronization
201201

202202
[REQUIREMENT]
@@ -222,9 +222,9 @@ STATEMENT: >>>
222222
The system shall implement a semaphore synchronization primitive for coordinating access to shared resources among multiple threads.
223223
<<<
224224

225-
[/SECTION]
225+
[[/SECTION]]
226226

227-
[SECTION]
227+
[[SECTION]]
228228
TITLE: Threads
229229

230230
[REQUIREMENT]
@@ -266,7 +266,7 @@ USER_STORY: >>>
266266
As a Zephyr RTOS user, I want to be able to give my threads different priorities for execution.
267267
<<<
268268

269-
[/SECTION]
269+
[[/SECTION]]
270270

271271
[REQUIREMENT]
272272
UID: ZEP-SYRS-18
@@ -294,7 +294,7 @@ USER_STORY: >>>
294294
As a Zephyr RTOS user, I want to be able to trace different OS operations.
295295
<<<
296296

297-
[SECTION]
297+
[[SECTION]]
298298
TITLE: Condition Variables
299299

300300
[REQUIREMENT]
@@ -307,9 +307,9 @@ STATEMENT: >>>
307307
The Zephyr RTOS shall provide a framework to synchronize threads based on a condition variable.
308308
<<<
309309

310-
[/SECTION]
310+
[[/SECTION]]
311311

312-
[SECTION]
312+
[[SECTION]]
313313
TITLE: Queues
314314

315315
[REQUIREMENT]
@@ -322,4 +322,4 @@ STATEMENT: >>>
322322
The Zephyr RTOS shall implement a queue which can be used to pass data between threads and interrupt service routines.
323323
<<<
324324

325-
[/SECTION]
325+
[[/SECTION]]

docs/system_requirements/system_requirements.sgra

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
[GRAMMAR]
22
ELEMENTS:
3+
- TAG: SECTION
4+
PROPERTIES:
5+
IS_COMPOSITE: True
6+
FIELDS:
7+
- TITLE: UID
8+
TYPE: String
9+
REQUIRED: False
10+
- TITLE: TITLE
11+
TYPE: String
12+
REQUIRED: True
313
- TAG: REQUIREMENT
414
FIELDS:
515
- TITLE: UID

requirements.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
strictdoc
1+
strictdoc>=0.9.1
2+

0 commit comments

Comments
 (0)