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

Fix clang warning about unused function #3154

Merged
merged 2 commits into from
Oct 29, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/util/logging.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,16 @@ enum class WriteFlag {

Q_DECLARE_FLAGS(WriteFlags, WriteFlag)

// Clang 10 complains about an unused function introduced by
// Q_DECLARE_OPERATORS_FOR_FLAGS
#if defined(__clang__)
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wunused-function"
Copy link
Member

Choose a reason for hiding this comment

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

This applies to the whole file. Can we just do it for the single function?

#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wunused-function"
// Code that throws warning goes here
#pragma clang diagnostic pop

Also, please add a comment why this is necessary.

Copy link
Member

Choose a reason for hiding this comment

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

Another thing: It this warning legit? If so, I assume that GCC doesn't throw the warning because it's buggy. If that's the case, it might get fixed in later versions of GCC. Hence, we could use this instead:

#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wunused-function"
// Code that throws warning goes here
#pragma GCC diagnostic pop

Apparently clang understands GCC pragmas, but not vice versa.

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 don't want to complicate the code unless actually needed. This could happen whenever using Q_DECLARE_OPERATORS_FOR_FLAGS, which defines functions that might never be used.

#endif
Q_DECLARE_OPERATORS_FOR_FLAGS(WriteFlags)
#if defined(__clang__)
#pragma clang diagnostic pop
#endif

// Handles actually writing to stderr and the log file.
inline void writeToLog(
Expand Down