Skip to content
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

Small cleanup fixes #211

Merged
merged 3 commits into from
Mar 22, 2023
Merged

Small cleanup fixes #211

merged 3 commits into from
Mar 22, 2023

Conversation

nkoenig
Copy link
Contributor

@nkoenig nkoenig commented Mar 14, 2023

🦟 Bug fix

Summary

This adds a missing <string> header file, and declares Plugin's virtual destructor so that a derived class's destructor can be called properly.

Checklist

  • Signed all commits for DCO
  • Added tests
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

Signed-off-by: Nate Koenig <[email protected]>
@github-actions github-actions bot added the 🏰 citadel Ignition Citadel label Mar 14, 2023
Signed-off-by: Nate Koenig <[email protected]>
Signed-off-by: Steve Peters <[email protected]>
@codecov
Copy link

codecov bot commented Mar 18, 2023

Codecov Report

Merging #211 (91a4ec3) into ign-launch2 (00b7eeb) will not change coverage.
The diff coverage is n/a.

❗ Current head 91a4ec3 differs from pull request most recent head 98860c9. Consider uploading reports for the commit 98860c9 to get more accurate results

@@             Coverage Diff              @@
##           ign-launch2     #211   +/-   ##
============================================
  Coverage        56.74%   56.74%           
============================================
  Files                2        2           
  Lines              326      326           
============================================
  Hits               185      185           
  Misses             141      141           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@@ -30,6 +30,9 @@ namespace ignition
/// \brief Base class for launch plugins.
class Plugin
{
// Default destructor
public: virtual ~Plugin() {}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ABI checker says that this breaks ABI. Does that matter?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's safe to ignore that. If a class inherited from Plugin and implemented a destructor, then this will allow that destructor to be called correctly. And it won't break their code. In a similar vein, if a child did not implement a destructor then the code should also be safe.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the size of the v-table is changed, so if there are any libraries that link against gz-launch plugins, this ABI change would break them. There probably aren't many things linking against these plugins though

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can choose to ignore it but wanted to be explicit about it

@nkoenig nkoenig merged commit 464af53 into ign-launch2 Mar 22, 2023
@nkoenig nkoenig deleted the nkoenig/small_patches branch March 22, 2023 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏰 citadel Ignition Citadel
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants