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

iox-#961 Use Multi-Arch compliant install destinations #957

Merged

Conversation

roehling
Copy link
Contributor

@roehling roehling commented Nov 2, 2021

Pre-Review Checklist for the PR Author

  1. Code follows the coding style of CONTRIBUTING.md
  2. Tests follow the best practice for testing
  3. Changelog updated in the unreleased section including API breaking changes
  4. Branch follows the naming format (iox-#123-this-is-a-branch)
  5. Commits messages are according to this guideline
    • Commit messages have the issue ID (iox-#123 commit text)
    • Commit messages are signed (git commit -s)
    • Commit author matches Eclipse Contributor Agreement (and ECA is signed)
  6. Update the PR title
    • Follow the same conventions as for commit messages
    • Link to the relevant issue
  7. Relevant issues are linked
  8. Add sensible notes for the reviewer
  9. All checks have passed (except task-list-completed)
  10. Assign PR to reviewer

Notes for Reviewer

Checklist for the PR Reviewer

  • Commits are properly organized and messages are according to the guideline
  • Code according to our coding style and naming conventions
  • Unit tests have been written for new behavior
  • Public API changes are documented via doxygen
  • Copyright owner are updated in the changed files
  • PR title describes the changes

Post-review Checklist for the PR Author

  1. All open points are addressed and tracked via issues

References

@dkroenke dkroenke self-requested a review November 2, 2021 10:15
@elfenpiff
Copy link
Contributor

@roehling Thanks for your contribution!

We are a project for safety critical systems and therefore we have to follow the traceability principle strictly. Could you please follow the contribution guidelines here: https://github.com/eclipse-iceoryx/iceoryx/blob/master/CONTRIBUTING.md

The essence is:

  1. Before creating a PR create an issue first which describes the task you would like to perform (one sentence can sometimes be enough)
  2. Create a branch which has the prefix iox-#??? where the ??? are the number of the issue you created.
  3. Every commit requires the prefix iox-#???, again with the issue number
  4. Please use our Pull Request template
  5. The PR name has to have again the iox-#??? prefix.

I know it is a little bit annoying but this is required to ensure the highest code quality and a later safety certification.

@dkroenke dkroenke added the tooling All iceoryx related tooling (scripts etc.) label Nov 2, 2021
Copy link
Contributor

@elfenpiff elfenpiff left a comment

Choose a reason for hiding this comment

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

The contents of the PR are fine but sadly I have to insist that you comply to the contribution guidelines.

@codecov
Copy link

codecov bot commented Nov 2, 2021

Codecov Report

Merging #957 (0943365) into master (2749f89) will increase coverage by 0.03%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #957      +/-   ##
==========================================
+ Coverage   77.62%   77.65%   +0.03%     
==========================================
  Files         335      334       -1     
  Lines       12315    12359      +44     
  Branches     1833     1837       +4     
==========================================
+ Hits         9559     9597      +38     
- Misses       2130     2135       +5     
- Partials      626      627       +1     
Flag Coverage Δ
unittests 76.55% <ø> (+0.03%) ⬆️
unittests_timing 30.35% <ø> (+0.25%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...e/relocatable_pointer/base_relocatable_pointer.cpp 0.00% <0.00%> (-12.50%) ⬇️
iceoryx_hoofs/source/concurrent/loffli.cpp 85.29% <0.00%> (ø)
...l/relocatable_pointer/base_relocatable_pointer.hpp
...ternal/relocatable_pointer/relocatable_pointer.inl
...s/internal/relocatable_pointer/relocatable_ptr.inl 96.00% <0.00%> (ø)

@roehling roehling changed the title Use Multi-Arch compliant install destinations iox-#961 Use Multi-Arch compliant install destinations Nov 2, 2021
Signed-off-by: Timo Röhling <timo@gaussglocke.de>
@roehling roehling force-pushed the use-multi-arch-installdirs branch from 61c4f30 to fa1c2de Compare November 2, 2021 10:56
@roehling
Copy link
Contributor Author

roehling commented Nov 2, 2021

PR has been updated.

@roehling roehling requested a review from elfenpiff November 2, 2021 10:57
@@ -18,6 +18,7 @@
# setup_package_name_and_create_files : this macro which is called from other modules which use iceoryx_hoofs
# sets the variables for package version file,config file used for configuration
# this also creates the config files
include(GNUInstallDirs)
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this also work on MacOS and Windows? I am asking since we are supporting those platforms.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, it does. By default, the module uses the GNU conventions, which happen to coincide with the previous hard-coded values. The special cases such as multi-arch lib locations are only triggered for system-wide installation to prefix /usr or /, and only on certain Linux distributions which support these.

Copy link
Member

Choose a reason for hiding this comment

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

If you want you can add your name to the copyright header

elfenpiff
elfenpiff previously approved these changes Nov 2, 2021
@dkroenke
Copy link
Member

dkroenke commented Nov 2, 2021

@roehling
Would add an entry in the unreleased section for #960 #961 and #962 ?

I guess this can go into the bugfix section and don't forget to add your name to it 😁

Signed-off-by: Timo Röhling <timo@gaussglocke.de>
@roehling
Copy link
Contributor Author

roehling commented Nov 2, 2021

I'll add the changelog entry for #960 to this PR, as the former has been merged already.
EDIT: I'll add all three as suggested, because it is easier to merge then.

Signed-off-by: Timo Röhling <timo@gaussglocke.de>
Signed-off-by: Timo Röhling <timo@gaussglocke.de>
Signed-off-by: Timo Röhling <timo@gaussglocke.de>
@dkroenke dkroenke merged commit 5cde78c into eclipse-iceoryx:master Nov 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tooling All iceoryx related tooling (scripts etc.)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Comply with Multi-Arch specification for installation on Debian systems
3 participants