Compile on build server with warnings as errors #237

jerryct · 2018-12-07T19:40:38Z

No description provided.

pull/tests/integration/sample_server.cc

gjasny · 2018-12-08T09:30:24Z

pull/src/handler.cc

@@ -113,7 +113,7 @@ static std::size_t WriteResponse(struct mg_connection* conn,
  return body.size();
 }

-bool MetricsHandler::handleGet(CivetServer* server,
+bool MetricsHandler::handleGet(CivetServer* /*server*/,


you could also write std::ignore = server; in the body. I always find the commented out parameters a little bit clumsy.

I followed the way clang-tidy does it:
https://clang.llvm.org/extra/clang-tidy/checks/misc-unused-parameters.html

So if /* ... */ is too clumsy isn't it then better to omit the name altogether?

I now removed the unused parameter name but I can change it to std::ignore if you think this is better.

core/include/prometheus/detail/utils.h

gjasny · 2018-12-08T09:35:45Z

CMakeLists.txt


 add_compile_options(
  $<$<AND:$<STREQUAL:$<COMPILE_LANGUAGE>,CXX>,$<CXX_COMPILER_ID:AppleClang>>:-Wno-deprecated-declarations>
+  $<$<AND:$<STREQUAL:$<COMPILE_LANGUAGE>,CXX>,$<CXX_COMPILER_ID:AppleClang>,$<VERSION_LESS:$<CXX_COMPILER_VERSION>,9.3>>:-Werror>


Could we guard that with a CMake option that will be enabled for CI? It is usually good practice to not use -Werror on the users compilers by default. Otherwise distributions will have to work-around it to not make their builds explode with newer compilers or uncommon platforms/architectures.

gjasny · 2018-12-08T09:36:17Z

CMakeLists.txt


 add_compile_options(
  $<$<AND:$<STREQUAL:$<COMPILE_LANGUAGE>,CXX>,$<CXX_COMPILER_ID:AppleClang>>:-Wno-deprecated-declarations>
+  $<$<AND:$<STREQUAL:$<COMPILE_LANGUAGE>,CXX>,$<CXX_COMPILER_ID:AppleClang>,$<VERSION_LESS:$<CXX_COMPILER_VERSION>,9.3>>:-Werror>
+  $<$<AND:$<STREQUAL:$<COMPILE_LANGUAGE>,CXX>,$<CXX_COMPILER_ID:AppleClang>,$<VERSION_LESS:$<CXX_COMPILER_VERSION>,9.3>>:-Wall>
+  $<$<AND:$<STREQUAL:$<COMPILE_LANGUAGE>,CXX>,$<CXX_COMPILER_ID:AppleClang>,$<VERSION_LESS:$<CXX_COMPILER_VERSION>,9.3>>:-Wextra>


Is there a reason you limit the warnings to certain compiler versions?

New compiler versions normally add new warnings to -Wall -Wextra. My rationale is that the current Travis CI uses two specific compilers and especially GCC 4.8 is rather old. So we can only ensure for these two compilers that we don't have any warnings. If we would unconditionally switch on -Wall ... with -Werror a user of this library who might use a newer GCC or Clang version, may run into the problem that he cannot compile this library anymore.

Do you know of a better solution?

done. If we guard the flags for the CI then the version number can be removed. My initial approach was differently to enable the flags for the user as long as the version is the same with the CI. But the guard is better.

I removed the no-deprecation-declarations. Is it ok?

jovany-wang

Left some comments :)

jovany-wang · 2018-12-09T14:16:57Z

core/src/detail/hash.h

@@ -11,7 +11,7 @@ namespace detail {
 /// It's the boundary condition of this serial functions.
 ///
 /// \param seed Not effect.
-inline void hash_combine(std::size_t *seed) {}


I think it's better to ignore seed in the body instead of remove seed.

jovany-wang · 2018-12-09T14:17:58Z

core/src/detail/hash.h

@@ -1,4 +1,4 @@
-#pragma


good catch!

jovany-wang · 2018-12-09T14:28:20Z

core/tests/histogram_test.cc

@@ -11,7 +11,7 @@ TEST(HistogramTest, initialize_with_zero) {
  Histogram histogram{{}};
  auto metric = histogram.Collect();
  auto h = metric.histogram;
-  EXPECT_EQ(h.sample_count, 0);


EXPECT_EQ(h.sample_count, 0U); ---> EXPECT_EQ(0U, h.sample_count);
IIRC, the 1st argument of the function EXPECT_EQ means the expected value, and the 2nd one is real value.

I only fixed the compiler warnings and preserve the order as it was.

jovany-wang · 2018-12-09T14:31:55Z

core/tests/histogram_test.cc

@@ -21,7 +21,7 @@ TEST(HistogramTest, sample_count) {
  histogram.Observe(200);
  auto metric = histogram.Collect();
  auto h = metric.histogram;


use histogram instead of the local variable h.

This change is not related to the commit intention (fixing compiler warnings).

jovany-wang · 2018-12-09T14:37:36Z

push/tests/integration/sample_client.cc

@@ -23,7 +23,7 @@ static std::string GetHostName() {
  return hostname;
 }

-int main(int argc, char** argv) {


Why remove the 2 parameters?
I think it's unnecessary to do this change.

argc and argv are not used in the function body.

But for unused parameters, we should not remove them directly.
Just use IGNORE to ignore them.

jovany-wang · 2018-12-09T14:38:19Z

pull/src/handler.cc

@@ -113,8 +113,7 @@ static std::size_t WriteResponse(struct mg_connection* conn,
  return body.size();
 }

-bool MetricsHandler::handleGet(CivetServer* server,
-                               struct mg_connection* conn) {


This change is unnecessary I think.

I enabled warnings. The warning complains about an unused parameter. server is not used in the function body.

Use ignore instead of removing it directly.

jovany-wang · 2018-12-09T14:39:57Z

core/tests/family_test.cc

@@ -20,8 +20,8 @@ TEST(FamilyTest, labels) {
                         {{const_label.name, const_label.value}}};
  family.Add({{dynamic_label.name, dynamic_label.value}});
  auto collected = family.Collect();
-  ASSERT_GE(collected.size(), 1);
-  ASSERT_GE(collected.at(0).metric.size(), 1);
+  ASSERT_GE(collected.size(), 1U);


I think the literal 1 is ok. It's unnecessary to use 1U.

I enabled warnings. size() returns an unsigned type and the warning complains about a compare between signed and unsigned.

jerryct force-pushed the warn branch 8 times, most recently from 3a56b29 to fec6049 Compare December 7, 2018 22:16

jerryct changed the title ~~Compile with warnings as errors on build server~~ Compile on build server with warnings as errors Dec 7, 2018

gjasny reviewed Dec 8, 2018

View reviewed changes

pull/tests/integration/sample_server.cc Outdated Show resolved Hide resolved

gjasny reviewed Dec 8, 2018

View reviewed changes

core/include/prometheus/detail/utils.h Show resolved Hide resolved

jerryct force-pushed the warn branch from fec6049 to f161766 Compare December 8, 2018 09:33

gjasny reviewed Dec 8, 2018

View reviewed changes

jerryct force-pushed the warn branch 2 times, most recently from 82a3db4 to b311f4b Compare December 8, 2018 10:12

jerryct added 3 commits December 8, 2018 11:15

Compile on build server with warnings as errors

2ccf6ac

Fix include guard

81bec36

Fix all warnings

e38d020

jerryct force-pushed the warn branch from b311f4b to e38d020 Compare December 8, 2018 10:15

jovany-wang reviewed Dec 9, 2018

View reviewed changes

gjasny merged commit 09f56af into jupp0r:master Dec 9, 2018

jerryct deleted the warn branch December 9, 2018 16:41

gjasny mentioned this pull request Dec 10, 2018

Build error due to bad pragma in utils.h #241

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Compile on build server with warnings as errors #237

Compile on build server with warnings as errors #237

jerryct commented Dec 7, 2018

gjasny Dec 8, 2018 •

edited

Loading

jerryct Dec 8, 2018

gjasny Dec 8, 2018

jerryct Dec 8, 2018 •

edited

Loading

gjasny Dec 8, 2018

jerryct Dec 8, 2018

jerryct Dec 8, 2018 •

edited

Loading

jerryct Dec 8, 2018 •

edited

Loading

jovany-wang left a comment

jovany-wang Dec 9, 2018

jovany-wang Dec 9, 2018

jovany-wang Dec 9, 2018

jerryct Dec 9, 2018 •

edited

Loading

jovany-wang Dec 9, 2018

jerryct Dec 9, 2018 •

edited

Loading

jovany-wang Dec 9, 2018

jerryct Dec 9, 2018

jovany-wang Dec 9, 2018

jovany-wang Dec 9, 2018

jerryct Dec 9, 2018 •

edited

Loading

jovany-wang Dec 9, 2018

jovany-wang Dec 9, 2018

jerryct Dec 9, 2018

jovany-wang Dec 9, 2018

Compile on build server with warnings as errors #237

Compile on build server with warnings as errors #237

Conversation

jerryct commented Dec 7, 2018

gjasny Dec 8, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jerryct Dec 8, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jerryct Dec 8, 2018 • edited Loading

Choose a reason for hiding this comment

jerryct Dec 8, 2018 • edited Loading

Choose a reason for hiding this comment

jovany-wang left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jerryct Dec 9, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jerryct Dec 9, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jerryct Dec 9, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gjasny Dec 8, 2018 •

edited

Loading

jerryct Dec 8, 2018 •

edited

Loading

jerryct Dec 8, 2018 •

edited

Loading

jerryct Dec 8, 2018 •

edited

Loading

jerryct Dec 9, 2018 •

edited

Loading

jerryct Dec 9, 2018 •

edited

Loading

jerryct Dec 9, 2018 •

edited

Loading