Merged
Conversation
github-actions
bot
added
documentation
Erikhu1
reviewed
Sep 25, 2025
.dotstop_extensions/README.md
Outdated
|
|
||
| ## ItemReference | ||
|
|
||
| To keep the documentation relatively slim, we have put references that could be used by all leaf nodes following a certain node into that particular node. |
Collaborator
There was a problem hiding this comment.
Somewhat confusing sentence. Maybe something in the style of "references which are used by all child nodes of a certain node are stored on the parent level, instead of repeated in each child node".
Author
There was a problem hiding this comment.
Child-node is ill-fitting, since the items that inherit the references are not necessarily directly supporting items.
.dotstop_extensions/README.md
Outdated
|
|
||
| To also detect the inheritance of references in the content of the item, the content of an ItemReference is the combination of the sha's stored in the .dotstop.dot file of all linked items. | ||
| Therefore, if any reference of any of the linked items changes, then the linked item becomes automatically invalidated. | ||
| When it is asserted that the references are still fitting, then the sha is expected to change, which automatically invalidates the item, thereby detecting the change of the references indirectly and with delay. |
Collaborator
There was a problem hiding this comment.
Again, a bit confusing which item you are referring to when saying e.g., "the sha is expected to change". SHA of which one?
"which automatically invalidates the item" --> maybe "child node" or establish some other term for the distinction
Author
There was a problem hiding this comment.
I attempted a re-formulation of this explanation.
.dotstop_extensions/references.py
Outdated
|
|
||
| @staticmethod | ||
| def get_reference_contents(items: list[str]) -> bytes: | ||
| # graph = pydot.graph_from_dot_file(".dotstop.dot")[0] |
Erikhu1
approved these changes
Sep 26, 2025
TSF/docs/introduction/index.rst
Outdated
| ---------- | ||
|
|
||
| The application of the Trustable Software Framework to version 3.12.0 of Niels Lohmann's JSON library involves a comprehensive assessment to ensure it meets our high-level requirements for external software. Key actions include formalizing necessary functionalities, addressing feature requests from SCORE, and integrating trustable evidence into a coherent project workflow. The library is maintained with stringent quality checks and evidence generation processes, illustrating a commitment to high standards and the practicality required for certifiable software projects. | ||
| The application of the Trustable Software Framework to Niels Lohmann's JSON library (version 3.12.0) involves a comprehensive assessment to ensure it meets our high-level requirements for external software. Key actions include formalizing necessary functionalities, addressing feature requests from SCORE, and integrating trustable evidence into a coherent project workflow. The library is maintained with stringent quality checks and evidence generation processes, illustrating a commitment to high standards and the practicality required for certifiable software projects. |
* add custom reference ItemReference * document ItemReference
For each item referring also to references of other nodes, add the corresponding ItemReferences
Since each reference's content was calculated, performance was quite bad. Therefore, the change of the content is now indirectly detected, only.
* PJD-04 already covered by NPFs -> removed PJD-04 * linked TA-UPDATES and AOU-27
Jonas-Kirchhoff
force-pushed
the
review_round_2_JK
branch
from
1563b0d to
6af22c7
Compare
Erikhu1
pushed a commit
that referenced
this pull request
Oct 8, 2025
* Add reference to nodes * add custom reference ItemReference * document ItemReference * add minor tests for ItemReference * add table for scoring rationale to documentation * add ItemReferences For each item referring also to references of other nodes, add the corresponding ItemReferences * change ItemReference Since each reference's content was calculated, performance was quite bad. Therefore, the change of the content is now indirectly detected, only. * fix orphan-nodes * PJD-04 already covered by NPFs -> removed PJD-04 * linked TA-UPDATES and AOU-27 * remove unused code * re-formulate documentation for clarification * adapt formulation to be precise * remove unused pydot * change import of LocalFileReference to suppress warnings * add clarification of scope * improve function-reference * correct section counting * fix typo SCORE -> S-CORE
Erikhu1
added a commit
that referenced
this pull request
Oct 23, 2025
* library version * AOU-03 shall * AOU-25 'used' standard library * fix AOU-26 * add context diagram * fix introduction * Review round 2 jk (#93) * Add reference to nodes * add custom reference ItemReference * document ItemReference * add minor tests for ItemReference * add table for scoring rationale to documentation * add ItemReferences For each item referring also to references of other nodes, add the corresponding ItemReferences * change ItemReference Since each reference's content was calculated, performance was quite bad. Therefore, the change of the content is now indirectly detected, only. * fix orphan-nodes * PJD-04 already covered by NPFs -> removed PJD-04 * linked TA-UPDATES and AOU-27 * remove unused code * re-formulate documentation for clarification * adapt formulation to be precise * remove unused pydot * change import of LocalFileReference to suppress warnings * add clarification of scope * improve function-reference * correct section counting * fix typo SCORE -> S-CORE * Review round 2 jk (#96) * fix function-reference * add support for multiline function declarations * add test for multiline function declaration * fix error-messages * Review round 2 jk (#101) * remove reference ListOfTestCases * add folder artifacts to gitignore * add generator for the list of test environments * generate list of test environments * add validator for list of test environments * document generator * implement evidence * remove obsolete tests * add tests for ListOfTestsGenerator * repair pytest execution --------- Signed-off-by: Erik Hu <135733975+Erikhu1@users.noreply.github.com> Signed-off-by: Jonas-Kirchhoff <jonas.kirchhoff@d-fine.com> Co-authored-by: Erik Hu <erik.hu@d-fine.com> Co-authored-by: Erik Hu <135733975+Erikhu1@users.noreply.github.com> * add root to syspath * remove @classmethods from init * clean up * clean up * explain generate_list_of_tests.py --------- Signed-off-by: Erik Hu <135733975+Erikhu1@users.noreply.github.com> Signed-off-by: Jonas-Kirchhoff <jonas.kirchhoff@d-fine.com> Co-authored-by: Jonas-Kirchhoff <jonas.kirchhoff@d-fine.com>
Erikhu1
added a commit
that referenced
this pull request
Nov 14, 2025
* library version * AOU-03 shall * AOU-25 'used' standard library * fix AOU-26 * add context diagram * fix introduction * Review round 2 jk (#93) * Add reference to nodes * add custom reference ItemReference * document ItemReference * add minor tests for ItemReference * add table for scoring rationale to documentation * add ItemReferences For each item referring also to references of other nodes, add the corresponding ItemReferences * change ItemReference Since each reference's content was calculated, performance was quite bad. Therefore, the change of the content is now indirectly detected, only. * fix orphan-nodes * PJD-04 already covered by NPFs -> removed PJD-04 * linked TA-UPDATES and AOU-27 * remove unused code * re-formulate documentation for clarification * adapt formulation to be precise * remove unused pydot * change import of LocalFileReference to suppress warnings * add clarification of scope * improve function-reference * correct section counting * fix typo SCORE -> S-CORE * Review round 2 jk (#96) * fix function-reference * add support for multiline function declarations * add test for multiline function declaration * fix error-messages * Review round 2 jk (#101) * remove reference ListOfTestCases * add folder artifacts to gitignore * add generator for the list of test environments * generate list of test environments * add validator for list of test environments * document generator * implement evidence * remove obsolete tests * add tests for ListOfTestsGenerator * repair pytest execution --------- Signed-off-by: Erik Hu <135733975+Erikhu1@users.noreply.github.com> Signed-off-by: Jonas-Kirchhoff <jonas.kirchhoff@d-fine.com> Co-authored-by: Erik Hu <erik.hu@d-fine.com> Co-authored-by: Erik Hu <135733975+Erikhu1@users.noreply.github.com> * add root to syspath * remove @classmethods from init * clean up * clean up * explain generate_list_of_tests.py --------- Signed-off-by: Erik Hu <135733975+Erikhu1@users.noreply.github.com> Signed-off-by: Jonas-Kirchhoff <jonas.kirchhoff@d-fine.com> Co-authored-by: Jonas-Kirchhoff <jonas.kirchhoff@d-fine.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Make clear how inheritance of references works.