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

cleanup core folder structure #1269

Merged
merged 11 commits into from
Nov 23, 2023
Merged

Conversation

rex-schilasky
Copy link
Contributor

@rex-schilasky rex-schilasky commented Nov 23, 2023

Description

All eCAL core subfolder reorganized.

image

Cherry-pick to

  • none

Copy link
Contributor

@KerstinKeller KerstinKeller left a comment

Choose a reason for hiding this comment

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

You can specify includes in two separate ways. With "" which by convention means relative to the current file, or with <> which means relative to a specified include directory passed with -I or in cmake target_include_directories.

For portability, I'd prefer to use the <> option, and always specify relative to the include directories which we provide, which in CMake are the include directory, thus #include<ecal/ecal.h>, or relative to the source directory for private headers. #include <config/ecal_config_reader.h>.

I'd prefer not to have `#include "../header.h", as those can break more easily.

@@ -1,4 +1,4 @@
# ========================= eCAL LICENSE =================================
# ========================= eCAL LICENSE =================================
Copy link
Contributor

Choose a reason for hiding this comment

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

Where does the space come from? :D

@@ -34,7 +34,7 @@
#endif

#include "ecal_def.h"
#include "ecal_writer.h"
#include "../ecal_writer.h"
Copy link
Contributor

Choose a reason for hiding this comment

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

Please no relative paths in our includes. rather "readwwrite/shm/ecal_writer.h" (so every include relative to the src (or include directory)

@rex-schilasky rex-schilasky merged commit 8bbd25f into master Nov 23, 2023
14 checks passed
@rex-schilasky rex-schilasky deleted the cleanup/core-folder-structure branch November 23, 2023 10:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants