Skip to content

Commit 0684f44

Browse files
json-lib: Rename JSON Parser to JSON-Library
Co-authored-by: rattenking52 <[email protected]> Signed-off-by: Alexandru Iulian <[email protected]>
1 parent 6295864 commit 0684f44

File tree

2 files changed

+9
-10
lines changed

2 files changed

+9
-10
lines changed

docs/features/baselibs/json/index.rst

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@
1212
# SPDX-License-Identifier: Apache-2.0
1313
# *******************************************************************************
1414
15-
JSON Parser
15+
JSON-Library
1616
===========================
1717

18-
.. document:: JSON Parser
18+
.. document:: JSON-Library
1919
:id: doc__json
2020
:status: valid
2121
:safety: ASIL_B
@@ -38,7 +38,7 @@ To activate this feature, use the following feature flag:
3838
Abstract
3939
========
4040

41-
This feature request proposes the integration of a safe JSON parser.
41+
This feature request proposes the integration of a safe JSON-Library with parsing functionality.
4242

4343

4444
Basic Functionality
@@ -55,13 +55,13 @@ Motivation
5555
==========
5656

5757
S-CORE is targeting high-performance automotive systems with safety impact.
58-
Some applications, like the IPC communication solution, require a safe JSON parser to enable loading of configuration information at runtime.
58+
Some applications, like the IPC communication solution, require a safe JSON-Library with parsing functionality to enable loading of configuration information at runtime.
5959
There is currently no solution for this inside S-CORE.
6060

6161
Rationale
6262
=========
6363

64-
A JSON parser needs to be introduced in S-CORE software platform due to specific functional dependencies of different features (ex: IPC).
64+
A JSON-Library with parsing functionality needs to be introduced in S-CORE software platform due to specific functional dependencies of different features (ex: IPC).
6565

6666
Further details are available in the following section:
6767
.. _Specification:
@@ -74,7 +74,7 @@ The following details and requirements describe the aspects of current feature i
7474
General considerations
7575
----------------------
7676

77-
The JSON parser should provide read and data conversion capabilities:
77+
The JSON-Library should provide parsing and data conversion capabilities:
7878

7979
:need:`feat_req__json__validation`
8080
:need:`feat_req__json__deserialization`
@@ -99,8 +99,7 @@ Full testability for the public API
9999
----------------------------------------
100100

101101
Our users will be required to proof certain coverage metrics, like line coverage or branch coverage.
102-
For them to reach full coverage, they need to be easily able to mock or fake parts of the JSON functionality in their
103-
unit tests.
102+
For them to reach full coverage, they need to be easily able to mock or fake the public API of the JSON-Library in their unit tests.
104103

105104
:need:`feat_req__json__testability_mock_api`
106105

docs/requirements/stakeholder/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -539,15 +539,15 @@ Communication
539539
* Diagnostic jobs
540540

541541

542-
.. stkh_req:: JSON parser
542+
.. stkh_req:: JSON-Library
543543
:id: stkh_req__communication__json_parser
544544
:reqtype: Functional
545545
:security: NO
546546
:safety: ASIL_B
547547
:rationale: tbd
548548
:status: valid
549549

550-
The software platform shall provide a JSON parser.
550+
The software platform shall provide a JSON-Library with parsing functionality.
551551

552552

553553
Hardware support

0 commit comments

Comments
 (0)