-
Notifications
You must be signed in to change notification settings - Fork 21
cpp impl: Split Up Files #55
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.
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
Conversation
Add score::mw::pers::kvs as a namespace for cpp implementation
Rename provisional "MyErrorCode" to "ErrorCode"
Split up files for a better code overview
License Check Results🚀 The license check job ran with the Bazel command: bazel run //:license-checkStatus: Click to expand output |
|
The created documentation from the pull request is available at: docu-html |
Update BUILD Files and smaller changes
Split Code-Files for Unittests + Add kvs_check_hash tests
add benchmark to workflow (e.g. to show compiler errors)
Update namespace definition to C++17
Rename Extract Coverage for "kvs.cpp" to "CPP Files"
add namespace to example usage
rename namespace from score::mw::pers:kvs to score::mw::per:kvs
| ********************************************************************************/ | ||
| #include "error.hpp" | ||
|
|
||
| namespace score::mw::per::kvs { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is the split of this internal folder for?
- It is not in internal namespace -should you have the namespace maybe according to folder structure?
example like in comm - namespace score::mw::com::impl - https://github.com/eclipse-score/communication/blob/main/score/mw/com/impl/com_error.h - And the error is anyway exposed to the user right
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried to replicate the folder structures of the baselibs components. E.g. JSON Component: Here we also have error files in an internal folder, but they still are exposed due to bazel deps.
I dont use an internal namespace for error, because if an application wants to use the kvs errorcode (e.g. while checking for an specific errorcode after a failed operation), you would always need to write an internal namespace for this, what is (at least in my understanding) not quite ideal. Json for example also doesnt have an impl namespace for errorcodes error.h json)
For "real" internal-only operations (like kvs_helper) we can align on the usage of an internal namespace, but since this change only affects the kvs itself and is no interface change, i personally would do this in a different PR and get this merged beforehand.
Also in the last FT Meeting we talked about the structure of internal files, because error is only semi internal since it is (as you said) exposed. So the question was, if the error files should be in the internal folder or directly in the src folder. We aligned, that this question should be taken in Architecture Community and we proceed like the way its currently done in Baselibs (and in this PR).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMHO
,Error should not be in internal folder . For others if you have a internal folder then it should mean that these are internal and not for public user right.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, we also thought this. But then on the other hand in more or less every baselibs component error is part of the internal folder. Thats why we moved this question to Architecture Community and change it in persistency afterwards if needed.
cpp impl: Split Up Files
This PR contains:
Coverage Report: coverage.zip