Skip to content

add time_daemon component requirements #153

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.

Sign up for GitHub

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

Draft
ryan-steel wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

add time_daemon component requirements #153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 15 additions & 36 deletions score/time_daemon/docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,7 @@
.. _time_daemon:

Time Daemon
#####################

.. note:: Document header
###########

.. document:: Time Daemon
:id: doc__time_daemon
Expand All @@ -28,52 +26,33 @@ Time Daemon
:realizes: wp__cmpt_request
:tags: time_daemon

.. note::
Work in progress: structure, titles, and needs IDs only. Content and req/comp/feat traceability links to follow in later PRs.

.. code-block:: rst

.. comp:: Time Daemon
:id: comp__time_daemon_template
:security: YES
:safety: ASIL_B
:status: invalid
:implements: logic_arc_int__feature_name__interface_name1
:consists_of: comp__component_name_internal_1, comp__component_name_internal_2, comp__component_name_internal_3
:belongs_to: feat__feature_name

.. attention::
The above directives must be updated according to your Component.

- Adjust ``status`` to be ``valid``
- Adjust ``safety`` and ``tags`` according to your needs
.. comp:: Time Daemon
:id: comp__time_daemon
:security: NO
:safety: ASIL_B
:status: valid
:version: 1
:belongs_to: feat__time

Abstract
========

[A short (~200 word) description of the component.]

This component implements a time synchronization daemon that receives time data from time_slave via IPC, performs verification and qualification, and provides validated time information to applications.

Specification
=============

[Describe the requirements, architecture of any component.] or


How to Teach This
=================
The component provides time data reception, verification, and qualification:

[How to teach users, new and experienced, how to apply the CR to their work.]

.. note::
For a CR that adds new functionality or changes behaviour, it is helpful to include a section on how to teach users, new and experienced, how to apply the CR to their work.
* :need:`comp_req__time_daemon__ipc_reception`
* :need:`comp_req__time_daemon__sync_validation`
* :need:`comp_req__time_daemon__time_jump_detection`
* :need:`comp_req__time_daemon__timeout_detection`
* :need:`comp_req__time_daemon__error_reporting`

Footnotes
=========

[A collection of footnotes cited in the CR, and a place to list non-inline hyperlink targets.]


Further Documentation of the component can be found in the following sections:

Component Detail Information
Expand Down
7 changes: 2 additions & 5 deletions score/time_daemon/docs/requirements/chklst_req_inspection.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@
.. document:: Time Daemon Requirements Inspection Checklist
:id: doc__time_daemon_req_inspection
:status: draft
:version: 2
:version: 1
:safety: ASIL_B
:security: YES
:security: NO
:realizes: wp__requirements_inspect
:tags: time_daemon

Expand Down Expand Up @@ -189,6 +189,3 @@ And also the following AoUs in "valid" state and with "inspected" tag set (for t
:columns: id;status;tags
:colwidths: 25,25,25
:sort: title

.. attention::
The above tables filtering must be updated according to your Component.
Loading
Loading