fsfw/fsfw
11
3
Fork 6
Code Issues 32 Pull Requests 4 Releases 10 Wiki Activity

Version Getter Function #575

Merged
gaisser merged 14 commits from eive/fsfw:mueller/version-getter-upstream into development 2022-03-14 14:44:38 +01:00
Conversation 6 Commits 14 Files Changed 7 +192 -9
muellerr commented 2022-03-08 10:09:20 +01:00
Owner
Copy Link
No description provided.
muellerr added 2 commits 2022-03-08 10:09:39 +01:00
function to get fsfw version ca70c8c614
update changelog
All checks were successful
fsfw/fsfw/pipeline/pr-development This commit looks good
Details
77e5fba7fd
muellerr requested review from gaisser 2022-03-08 10:10:55 +01:00
muellerr added the feature label 2022-03-08 10:11:00 +01:00
muellerr added this to the v5.0.0 milestone 2022-03-08 10:40:27 +01:00
gaisser reviewed 2022-03-09 12:55:26 +01:00
src/fsfw/version.h
@@ -0,0 +8,4 @@
struct Version {
uint32_t major = 0;
uint32_t minor = 0;
uint32_t revision = 0;
gaisser commented 2022-03-09 12:55:25 +01:00
Owner
Copy Link

Can you changed that to the next milestone 5.0.0?

Can you changed that to the next milestone 5.0.0?
muellerr commented 2022-03-09 13:11:52 +01:00
Author
Owner
Copy Link

AH, you want the struct default value to be the current version? Then it might sense to initialize these values to the preprocessor define values right aways.. which would make the geztter function kind of obsolete..

AH, you want the struct default value to be the current version? Then it might sense to initialize these values to the preprocessor define values right aways.. which would make the geztter function kind of obsolete..
mohr commented 2022-03-09 18:07:16 +01:00
Owner
Copy Link

Good point :)

Still I am with Steffen on this one. How about making the Version members even static const. I think the basic task was to make the Version accessible in a native C way, which fsfw::Version:major in my view is.

Instead of a getter, I would propose to add operators > == < <= >= for Version, to allow doing something with the information, like

if (fsfw::Version >= fsfw::VersionUser(4,3,0))

NB My example would need a non static const Variant of the class, maybe someone finds a more clever version.

Good point :) Still I am with Steffen on this one. How about making the `Version` members even `static const`. I think the basic task was to make the Version accessible in a native C way, which `fsfw::Version:major` in my view is. Instead of a getter, I would propose to add operators `>` `==` `<` `<=` `>=` for Version, to allow doing something with the information, like ``` if (fsfw::Version >= fsfw::VersionUser(4,3,0)) ``` NB My example would need a non static const Variant of the class, maybe someone finds a more clever version.
mohr marked this conversation as resolved
muellerr commented 2022-03-09 19:07:27 +01:00
Author
Owner
Copy Link

Implemented extended Version class and const FSFW_VERSION class.

WIP, TODO:

  • Still need to unit test this. Also, it might be not the most efficient implementation (maybe at least the least simple one for the operators?) but that should not be too concerning for this use-case
  • Other feature: Implement << operator to print <Major>.<Minor>.<Revision>.
  • Update CHANGELOG
Implemented extended `Version` class and const `FSFW_VERSION` class. WIP, TODO: - Still need to unit test this. Also, it might be not the most efficient implementation (maybe at least the least simple one for the operators?) but that should not be too concerning for this use-case - Other feature: Implement `<<` operator to print `<Major>.<Minor>.<Revision>.` - Update CHANGELOG
muellerr changed title from Version Getter Function to WIP: Version Getter Function 2022-03-09 19:07:38 +01:00
muellerr added 1 commit 2022-03-09 19:08:18 +01:00
improved version.h
All checks were successful
fsfw/fsfw/pipeline/pr-development This commit looks good
Details
345a799031
muellerr added 1 commit 2022-03-09 19:10:34 +01:00
getter not required anymore
All checks were successful
fsfw/fsfw/pipeline/pr-development This commit looks good
Details
ca508bfe61
mohr reviewed 2022-03-09 20:18:12 +01:00
src/fsfw/version.h Outdated
@@ -0,0 +28,4 @@
friend bool operator<=(const Version& v1, const Version& v2) { return ((v1 == v2) or (v1 < v2)); }
friend bool operator>=(const Version& v1, const Version& v2) { return ((v1 == v2) or (v1 > v2)); }
};
mohr commented 2022-03-09 20:18:12 +01:00
Owner
Copy Link

If I am not mistaken, >= equals not < and > equals not(==) and not(<)

If I am not mistaken, `>=` equals `not <` and `>` equals `not(==) and not(<)`
mohr commented 2022-03-09 20:19:23 +01:00
Owner
Copy Link

Also, +1 for the << operator

Also, +1 for the `<<` operator
muellerr commented 2022-03-10 09:35:21 +01:00
Author
Owner
Copy Link

Done. Added C-style getVersion as well.

Done. Added C-style `getVersion` as well.
muellerr changed title from WIP: Version Getter Function to Version Getter Function 2022-03-10 09:35:33 +01:00
muellerr added 1 commit 2022-03-10 09:35:41 +01:00
added tests
Some checks failed
fsfw/fsfw/pipeline/pr-development There was a failure building this commit
Details
7daa9812ff
muellerr added 1 commit 2022-03-10 09:36:46 +01:00
update changelog
Some checks failed
fsfw/fsfw/pipeline/pr-development There was a failure building this commit
Details
949549178a
muellerr changed title from Version Getter Function to WIP: Version Getter Function 2022-03-10 09:38:21 +01:00
muellerr added 1 commit 2022-03-10 09:38:47 +01:00
added some more minor tests
Some checks failed
fsfw/fsfw/pipeline/pr-development There was a failure building this commit
Details
3779b44813
muellerr added 1 commit 2022-03-10 09:40:43 +01:00
minor tweaks
All checks were successful
fsfw/fsfw/pipeline/pr-development This commit looks good
Details
6b1a81ee92
muellerr changed title from WIP: Version Getter Function to Version Getter Function 2022-03-10 09:40:49 +01:00
muellerr added 1 commit 2022-03-10 09:44:14 +01:00
this tests even a bit more
All checks were successful
fsfw/fsfw/pipeline/pr-development This commit looks good
Details
14ac852b7e
muellerr changed title from Version Getter Function to WIP: Version Getter Function 2022-03-10 09:57:22 +01:00
muellerr added 2 commits 2022-03-10 09:58:49 +01:00
undef major and minor aa5d1042f0
avoid namespace pollution
Some checks failed
fsfw/fsfw/pipeline/pr-development There was a failure building this commit
Details
e684680d60
muellerr changed title from WIP: Version Getter Function to Version Getter Function 2022-03-10 10:00:32 +01:00
muellerr added 1 commit 2022-03-14 14:24:46 +01:00
Merge remote-tracking branch 'upstream/development' into mueller/version-getter-upstream
Some checks failed
fsfw/fsfw/pipeline/pr-development There was a failure building this commit
Details
97c93afeff
muellerr added 1 commit 2022-03-14 14:37:45 +01:00
bugfix
Some checks failed
fsfw/fsfw/pipeline/pr-development There was a failure building this commit
Details
ce5bcc5897
muellerr added 1 commit 2022-03-14 14:38:27 +01:00
Merge remote-tracking branch 'upstream/development' into mueller/version-getter-upstream
All checks were successful
fsfw/fsfw/pipeline/pr-development This commit looks good
Details
522cbc7f3d
gaisser merged commit 288d453978 into development 2022-03-14 14:44:38 +01:00
gaisser deleted branch mueller/version-getter-upstream 2022-03-14 14:44:40 +01:00
gaisser approved these changes 2022-03-14 14:48:37 +01:00
gaisser left a comment
Owner
Copy Link

LGTM

LGTM
Sign in to join this conversation.
Reviewers
No Reviewers
mohr
gaisser
Labels
Clear labels
API Change
Changes the API, so Users need to adapted
 Breaking API Change
Changes the API in a non backwards compatible way
 bug
Something is not working
 build
Issues related to the buildsystem, including CI
 cosmetics
Small change most users won't notice
 Documentation
Improvement of code documentation
 duplicate
This issue or pull request already exists
 feature
New feature
 help wanted
Need some help
 hotfix
Quick or important fix that is merged directly into master, causing a new revision
 invalid
#worksforme
 question
More information is needed
 Refactor
Contains a refactoring of some code
 Tests
Issues related to testing code
 wontfix
This won't be fixed
No Label feature
Milestone
No items
No Milestone v5.0.0
Assignees
Clear assignees
ahinkel dwoodward gaisser hanke jenkins_buildfix lrajer meierj mohr muellerr taheran tbaumgartl
No Assignees
3 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: fsfw/fsfw#575
Delete Branch "eive/fsfw:mueller/version-getter-upstream"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?