reqmgmt: Add Kernel Version requirements (Issue #119 initial slice)#140
Conversation
…initial slice)
Add ZEP-SYRS-26 (system) and ZEP-SRS-26-{1,2} (software) for kernel
version information retrieval and element access, linked by Parent
relation. Adds version.sdoc to the software requirements index and a
Kernel Version section to the system requirements index.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
| COMPONENT: Kernel Version | ||
| TITLE: Kernel version information retrieval | ||
| STATEMENT: >>> | ||
| The Zephyr RTOS shall provide a mechanism to retrieve the kernel version information for the present build. |
There was a problem hiding this comment.
I would suggest replacing information by code which is less ambiguous about the return type (an encoded value of major, minor and patch level)
There was a problem hiding this comment.
| The Zephyr RTOS shall provide a mechanism to retrieve the kernel version information for the present build. | |
| The Zephyr RTOS shall provide a mechanism to retrieve the kernel version code. |
There was a problem hiding this comment.
Could also consider simplifying to "The Zephyr RTOS shall provide a mechanism to retrieve the kernel version."
| COMPONENT: Kernel Version | ||
| TITLE: Kernel version element extraction | ||
| STATEMENT: >>> | ||
| The Zephyr RTOS shall provide a mechanism to obtain the major, minor, and patch level elements of the kernel version information for the present build. |
There was a problem hiding this comment.
Same here, I would use code instead of information.
There was a problem hiding this comment.
Also, I don't think we need to repeat "present build" as this already stated in system requirement.
| The Zephyr RTOS shall provide a mechanism to obtain the major, minor, and patch level elements of the kernel version information for the present build. | |
| The Zephyr RTOS shall provide a mechanism to obtain the major, minor, and patch level elements from the kernel version code. |
There was a problem hiding this comment.
Rework and add the concept of a "compile-time mechanism" to set these (now only the obtain/get portion is covered)
Consider "The Zephyr RTOS shall provide compile-time mechanism to define the major, minor, and patch components of the kernel version."
Could also consider 1. splitting in 3 for atomicity or 2. removing the concept of major.minor.patch from the requirement to decouple from code
2. would give "The Zephyr RTOS shall provide a compile-time mechanism to define the kernel version.""
| COMPONENT: Kernel Version | ||
| TITLE: Kernel version information retrieval | ||
| STATEMENT: >>> | ||
| The Zephyr RTOS shall provide a mechanism to retrieve the kernel version information for the present build. |
There was a problem hiding this comment.
Could also consider simplifying to "The Zephyr RTOS shall provide a mechanism to retrieve the kernel version."
| COMPONENT: Kernel Version | ||
| TITLE: Kernel version element extraction | ||
| STATEMENT: >>> | ||
| The Zephyr RTOS shall provide a mechanism to obtain the major, minor, and patch level elements of the kernel version information for the present build. |
There was a problem hiding this comment.
Rework and add the concept of a "compile-time mechanism" to set these (now only the obtain/get portion is covered)
Consider "The Zephyr RTOS shall provide compile-time mechanism to define the major, minor, and patch components of the kernel version."
Could also consider 1. splitting in 3 for atomicity or 2. removing the concept of major.minor.patch from the requirement to decouple from code
2. would give "The Zephyr RTOS shall provide a compile-time mechanism to define the kernel version.""
Add an initial narrow slice of Kernel Version requirements in support of #119.
Changes:
docs/system_requirements/index.sdoc: Add ZEP-SYRS-26 — system-level parent for kernel version informationdocs/software_requirements/version.sdoc: Add ZEP-SRS-26-1 (retrieval) and ZEP-SRS-26-2 (element access)docs/software_requirements/index.sdoc: Registerversion.sdocScope note:
This PR intentionally covers retrieval and major/minor/patch element access only.
Broader version or release policy requirements are out of scope.
The component name
Kernel Versionis used to distinguish this topic from release policy concerns;open to renaming if the maintainers prefer
VersionorBuild Version.Methodology note (first trial):
This contribution is a trial of an AI-assisted requirements engineering workflow:
Feedback on both the requirements and the AI-assisted process is welcome.