c++ – Why should I always enable compiler warnings?

The Question :

311 people think this question is useful

I often hear that when compiling C and C++ programs I should “always enable compiler warnings”. Why is this necessary? How do I do that?

Sometimes I also hear that I should “treat warnings as errors”. Should I? How do I do that?

The Question Comments :

The Answer 1

351 people think this answer is useful

Why enable warnings?

C and C++ compilers are notoriously bad at reporting some common programmer mistakes by default, such as:

  • forgetting to initialise a variable
  • forgetting to return a value from a function
  • arguments in printf and scanf families not matching the format string
  • a function is used without being declared beforehand (C only)

These can be detected and reported, just usually not by default; this feature must be explicitly requested via compiler options.

How to enable warnings?

This depends on your compiler.

Microsoft C and C++ compilers understand switches like /W1, /W2, /W3, /W4 and /Wall. Use at least /W3. /W4 and /Wall may emit spurious warnings for system header files, but if your project compiles cleanly with one of these options, go for it. These options are mutually exclusive.

Most other compilers understand options like -Wall, -Wpedantic and -Wextra. -Wall is essential and all the rest are recommended (note that, despite its name, -Wall only enables the most important warnings, not all of them). These options can be used separately or all together.

Your IDE may have a way to enable these from the user interface.

Why treat warnings as errors? They are just warnings!

A compiler warning signals a potentially serious problem in your code. The problems listed above are almost always fatal; others may or may not be, but you want compilation to fail even if it turns out to be a false alarm. Investigate each warning, find the root cause, and fix it. In the case of a false alarm, work around it — that is, use a different language feature or construct so that the warning is no longer triggered. If this proves to be very hard, disable that particular warning on a case by case basis.

You don’t want to just leave warnings as warnings even if all of them are false alarms. It could be OK for very small projects where the total number of warnings emitted is less than 7. Anything more, and it’s easy for a new warning to get lost in a flood of old familiar ones. Don’t allow that. Just cause all your project to compile cleanly.

Note this applies to program development. If you are releasing your project to the world in the source form, then it might be a good idea not to supply -Werror or equivalent in your released build script. People might try to build your project with a different version of the compiler, or with a different compiler altogether, which may have a different set of warnings enabled. You may want their build to succeed. It is still a good idea to keep the warnings enabled, so that people who see warning messages could send you bug reports or patches.

How to treat warnings as errors?

This is again done with compiler switches. /WX is for Microsoft, most others use -Werror. In either case, the compilation will fail if there are any warnings produced.

The Answer 2

96 people think this answer is useful

C is, famously, a rather low-level language as HLLs go. C++, though it might seem to be a considerably higher-level language than C, still shares a number of its traits. And one of those traits is that the languages were designed by programmers, for programmers — and, specifically, programmers who knew what they were doing.

[For the rest of this answer I’m going to focus on C. Most of what I’ll say also applies to C++, though perhaps not as strongly. Although as Bjarne Stroustrup has famously said, “C makes it easy to shoot yourself in the foot; C++ makes it harder, but when you do it blows your whole leg off.”]

If you know what you are doing — really know what you are doing — sometimes you may have to “break the rules”. But most of the time, most of us will agree that well-intentioned rules keep us all out of trouble, and that wantonly breaking those rules all the time is a bad idea.

But in C and C++, there are surprisingly large numbers of things you can do that are “bad ideas” but which aren’t formally “against the rules”. Sometimes they’re a bad idea some of the time (but might be defensible other times); sometimes they’re a bad idea virtually all of the time. But the tradition has always been not to warn about these things — because, again, the assumption is that programmers know what they are doing, they wouldn’t be doing these things without a good reason, they’d be annoyed by a bunch of unnecessary warnings.

But of course not all programmers really know what they’re doing. And, in particular, every C programmer (no matter how experienced) goes through a phase of being a beginning C programmer. And even experienced C programmers can get careless and make mistakes.

Finally, experience has shown not only that programmers do make mistakes, but that these mistakes can have real, serious consequences. If you make a mistake, and the compiler doesn’t warn you about it, and somehow the program doesn’t immediately crash or do something obviously wrong because of it, the mistake can lurk there, hidden, sometimes for years, until it causes a really big problem.

So it turns out that, most of the time, warnings are a good idea, after all. Even the experienced programmers have learned (actually, it’s “especially the experienced programmers have learned”) that, on balance, the warnings tend to do more good than harm. For every time you did something wrong deliberately and the warning was a nuisance, there are probably at least ten times you did something wrong by accident and the warning saved you from further trouble. And most warnings can be disabled or worked around for those few times when you really want to do the “wrong” thing.

(A classic example of such a “mistake” is the test if(a = b). Most of the time, this is a mistake, so most compilers these days warn about it — some even by default. But if you really wanted to both assign b to a and test the result, you can disable the warning by typing if((a = b)).)

The second question is, why would you want to ask the compiler to treat warnings as errors? I’d say it’s because of human nature, specifically, the all-too-easy reaction of saying “Oh, that’s just a warning, that’s not so important, I’ll clean that up later.” But if you’re a procrastinator (and I don’t know about you, but I’m a terrible procrastinator) it’s easy to put off the necessarily cleanup for basically ever — and if you get into the habit of ignoring warnings, it gets easier and easier to miss an important warning message that’s sitting there, unnoticed, in the midst of all the ones you’re ignoring.

So asking the compiler to treat warnings as errors is a little trick you can play on yourself to get around this human foible.

Personally, I’m not as insistent about treating warnings as errors. (In fact, if I’m honest, I can say that I virtually never enable that option in my “personal” programming.) But you can be sure I’ve got that option enabled at work, where our style guide (which I wrote) mandates its use. And I would say — I suspect most professional programmers would say — that any shop that doesn’t treat warnings as errors in C is behaving irresponsibly, is not adhering to commonly-accepted industry best practices.

The Answer 3

40 people think this answer is useful

Warnings consist of the best advice some of the most skilled C++ developers could bake into an application. They’re worth keeping around.

C++, being a Turing complete language, has plenty of cases where the compiler must simply trust that you knew what you are doing. However, there are many cases where the compiler can realize that you probably did not intend to write what you wrote. A classic example is printf() codes which don’t match the arguments, or std::strings passed to printf (not that that ever happens to me!). In these cases, the code you wrote is not an error. It is a valid C++ expression with a valid interpretation for the compiler to act on. But the compiler has a strong hunch that you simply overlooked something which is easy for a modern compiler to detect. These are warnings. They are things that are obvious to a compiler, using all the strict rules of C++ at its disposal, that you might have overlooked.

Turning warnings off, or ignoring them, is like choosing to ignore free advice from those more skilled than you. Its a lesson in huberis that ends either when you fly too close to the sun and your wings melt, or a memory corruption error occurs. Between the two, I’ll take falling from the sky any day!

“Treat warnings as errors” is the extreme version of this philosophy. The idea here is that you resolve every warning the compiler gives you — you listen to every bit of free advice and act on it. Whether this is a good model for development for you depends on the team and what kind of product you are working on. It’s the ascetic approach that a monk might have. For some, it works great. For others, it does not.

On many of my applications we do not treat warnings as errors. We do this because these particular applications need to compile on several platforms with several compilers of varying ages. Sometimes we find it is actually impossible to fix a warning on one side without it turning into a warning on another platform. So we are merely careful. We respect warnings, but we don’t bend over backwards for them.

The Answer 4

19 people think this answer is useful

Not only does handling the warnings make better code, it makes you a better programmer. Warnings will tell you about things that may seem little to you today, but one day that bad habit will come back and bite your head off.

Use the correct type, return that value, evaluate that return value. Take time and reflect “Is this really the correct type in this context?” “Do I need to return this?” And the biggie; “Is this code going to be portable for the next 10 years?”

Get into the habit of writing warning-free code in the first place.

The Answer 5

18 people think this answer is useful

Non-fixed warnings will, sooner or later, lead to errors in your code.

Debugging a segmentation fault, for instance, requires the programmer to trace the root (cause) of the fault, which usually is located in a prior place in your code than the line that eventually caused the segmentation fault.

It’s very typical that the cause is a line for which the compiler had issued a warning that you ignored, and the line that caused the segmentation fault the line that eventually threw the error.

Fixing the warning leads to fixing the problem.. A classic!

A demonstration of the above.. Consider the following code:

#include <stdio.h>

int main(void) {
  char* str = "Hello world!";
  int idx;

  // Colossal amount of code here, irrelevant to 'idx'

  printf("%c\n", str[idx]);

  return 0;

which when compiled with “Wextra” flag passed to GCC, gives:

main.c: In function 'main':
main.c:9:21: warning: 'idx' is used uninitialized in this function [-Wuninitialized]
    9 |   printf("%c\n", str[idx]);
      |                     ^

which I could ignore and execute the code anyway.. And then I would witness a “grand” segmentation fault, as my IP epicurus professor used to say:

Segmentation fault

In order to debug this in a real world scenario, one would start from the line that causes the segmentation fault and attempt to trace what is the root of the cause.. They would have to search for what has happened to i and str inside that colossal amount of code over there…

Until, one day, they found theirselves in the situation where they discover that idx is used uninitialized, thus it has a garbage value, which results in indexing the string (way) beyond out of its bounds, which leads to a segmentation fault.

If only they hadn’t ignored the warning, they would have found the bug immediately!

The Answer 6

17 people think this answer is useful

The other answers are excellent and I don’t want to repeat what they have said.

One other aspect to “why enable warnings” that hasn’t properly been touched on is that they help enormously with code maintenance. When you write a program of significant size, it becomes impossible to keep the whole thing in your head at once. You typically have a function or three that you’re actively writing and thinking about, and perhaps a file or three on your screen that you can refer to, but the bulk of the program exists in the background somewhere and you have to trust that it keeps working.

Having warnings on, and having them as energetic and in your face as possible, helps to alert you if something you change makes trouble for something that you can’t see.

Take for example, the clang warning -Wswitch-enum. That triggers a warning if you use a switch on an enum and miss out one of the possible enum values. It’s something you might think would be an unlikely mistake to make: you probably at least looked at the list of enum values when you wrote the switch statement. You might even have an IDE that generated the switch options for you, leaving no room for human error.

This warning really comes into its own when, six months later you add another possible entry to the enum. Again, if you’re thinking about the code in question you’ll probably be fine. But if this enum is used for multiple different purposes and it’s for one of those that you need the extra option, it’s very easy to forget to update a switch in a file you haven’t touched for 6 months.

You can think of warnings in the same way as you’d think of automated test cases: they help you make sure that the code is sensible and doing what you need when you first write it, but they help even more to make sure that it keeps doing what you need while you prod at it. The difference is that test cases work very narrowly to the requirements of your code and you have to write them, while warnings work broadly to sensible standards for almost all code, and they’re very generously supplied by the boffins who make the compilers.

The Answer 7

15 people think this answer is useful

Treating warnings as errors is just a mean of self-discipline: you were compiling a program to test that shiny new feature, but you can’t until you fix the sloppy parts. There is no additional information Werror provides, it just sets priorities very clearly:

Don’t add new code until you fix problems in the existing code

It’s really the mindset that’s important, not the tools. Compiler diagnostics output is a tool. MISRA (for embedded C) is another tool. It doesn’t matter which one you use, but arguably compiler warnings is the easiest tool you can get (it’s just one flag to set) and the signal to noise ratio is very high. So there’s no reason not to use it.

No tool is infallible. If you write const float pi = 3.14;, most tools won’t tell you that you defined π with a bad precision which may lead to problems down the road. Most tools won’t raise an eyebrow on if(tmp < 42), even if it’s commonly known that giving variables meaningless names and using magic numbers is a way to disaster in big projects. You have to understand that any “quick test” code you write is just that: a test, and you have to get it right before you move on to other tasks, while you still see its shortcomings. If you leave that codes as is, debugging if after you spend two months adding new features will be significantly harder.

Once you get into the right mindset, there is no point in using Werror. Having warnings as warnings will allow you to take an informed decision whether it still makes sense to run that debug session you were about to start, or to abort it and fix the warnings first.

The Answer 8

8 people think this answer is useful

As someone who works with legacy embedded C code, enabling compiler warnings has helped show a lot of weakness and areas to investigate when proposing fixes. In gcc utilizing -Wall and -Wextra and even -Wshadow have become vital. I’m not going to go every single hazard, but I’ll list a few that have popped up that helped show code issues.

Variables being left behind

This one can easily point to unfinished work and areas that might not be utilizing all of the passed variables which could be an issue. Let’s look at a simple function that may trigger this:

int foo(int a, int b)
   int c = 0;

   if (a > 0)
        return a;
   return 0;

Just compiling this without -Wall or -Wextra returns no issues. -Wall will tell you though that c is never used:

foo.c: In function ‘foo’:

foo.c:9:20: warning: unused variable ‘c’ [-Wunused-variable]

-Wextra will also tell you that your parameter b doesn’t do anything:

foo.c: In function ‘foo’:

foo.c:9:20: warning: unused variable ‘c’ [-Wunused-variable]

foo.c:7:20: warning: unused parameter ‘b’ [-Wunused-parameter] int foo(int a, int b)

Global Variable shadowing

This one bit hard and did not show up until -Wshadow was used. Let’s modify the example above to just add, but there just happens to be a global with the same name as a local which causes a lot of confusion when trying to use both.

int c = 7;

int foo(int a, int b)
   int c = a + b;
   return c;

When -Wshadow was turned on, it’s easy to spot this issue.

foo.c:11:9: warning: declaration of ‘c’ shadows a global declaration [-Wshadow]

foo.c:1:5: note: shadowed declaration is here

Format strings

This doesn’t require any extra flags in gcc, but it has still be the source of problems in the past. A simple function trying to print data, but has a formatting error could look like this:

void foo(const char * str)
    printf("str = %d\n", str);

This doesn’t print the string since the formatting flag is wrong and gcc will happily tell you this is probably not what you wanted:

foo.c: In function ‘foo’:

foo.c:10:12: warning: format ‘%d’ expects argument of type ‘int’, but argument 2 has type ‘const char *’ [-Wformat=]

These are just three of the many things the compiler can double check for you. There are a lot of others like using an uninitialized variable that others have pointed out.

The Answer 9

6 people think this answer is useful

This is a specific answer to C, and why this is far more important to C than to anything else.

#include <stdio.h>
int main()
   FILE *fp = "some string";

This code compiles with a warning. What are and should be errors in just about every other language on the planet (barring assembly language) are warnings in C. Warnings in C are almost always errors in disguise. Warnings should be fixed, not suppressed.

With gcc, we do this as gcc -Wall -Werror.

This was also the reason for the high rantyness about some MS non-secure API warnings. Most people programming C have learned the hard way to treat warnings as errors and this stuff appeared that just wasn’t the same kind of thing and wanted non-portable fixes.

The Answer 10

6 people think this answer is useful

COMPILER WARNINGS ARE YOUR FRIEND (not shouting, uppercase for emphasis).

I work on legacy Fortran-77 systems. The compiler tells me valuable things: argument datatype mismatches on a subroutine call, using a local variable before a value has been set into the variable, if I have a variable or subroutine argument that is not used. These are almost always errors.

Avoiding a long post: When my code compiles cleanly, 97% it works. The other guy I work with compiles with all warnings off, spends hours or days in the debugger, then asks me to help. I just compile his code with the warnings on and tell him what to fix.

The Answer 11

6 people think this answer is useful

You should always enable compiler warnings because the compiler can often tell you what’s wrong with your code. To do this, you pass -Wall -Wextra to the compiler.

You should usually treat warnings as errors because the warnings usually signify that there’s something wrong with your code. However, it’s often very easy to ignore these errors. Therefore, treating them as errors will cause the build to fail so you can’t ignore the errors. To treat warnings as errors, pass -Werror to the compiler.

The Answer 12

5 people think this answer is useful

I once worked for a large (Fortune 50) company that manufactured electronic testing equipment.

The core product of my group was an MFC program that, over the years, came to generate literally hundreds of warnings. Which were ignored in almost all cases.

This is a frigging nightmare when bugs occur.

After that position, I was lucky enough to be hired as the first developer in a new startup.

I encouraged a ‘no warning’ policy for all builds, with compiler warning levels set to be pretty noisy.

Our practice was to use #pragma warning – push/disable/pop for code that the developer was sure was really fine, along with a log statement at the debug level, just in case.

This practice worked well for us.

The Answer 13

4 people think this answer is useful

The compiler warnings in C++ is very useful for some reasons.

1 – It permit to show you where you can have made a mistake who can impact the final result of your operations. For example if you didn’t initialize a variable or if you put “=” instead of “==” ( there are just examples )

2 – It permits also to show you where your code is not conform to the standard of the c++. It’s useful because if the code is conform to the actual standard it will be easy to move the code into an other plateform for example.

In general, the warnings are very useful to show you where you have mistakes in your code who can affect the result of your algorithm or prevent some error when the user will use your program.

The Answer 14

4 people think this answer is useful

A warning is an error waiting to happen. So you must enable compiler warnings and tidy up your code to remove any warning.

The Answer 15

4 people think this answer is useful

Ignoring warnings means you left sloppy code that not only could cause problems in the future for someone else, but also will make important compile messages less noticed by you. The more compiler output, the less anyone will notice or bother. Cleaner the better. It also means you know what you are doing. Warnings are very unprofessional, careless, and risky.

The Answer 16

3 people think this answer is useful

There’s only one problem with treating warnings as errors: When you’re using code coming from other sources (e.g., micro$**t libraries, open source projects), they didn’t do their job right, and compiling their code generates tons of warnings.

I always write my code so it doesn’t generate any warnings or errors, and clean it up until it compiles without generating any extraneous noise. The garbage I have to work with appalls me, and I’m astounded when I have to build a big project and watch a stream of warnings go by where the compilation should only be announcing which files it processed.

I also document my code because I know the real lifetime cost of software comes mostly from maintenance, not from writing it initially, but that’s a different story…

The Answer 17

2 people think this answer is useful

Some warning may mean possible semantic error in code or possible UB. E.g. ; after if(), unused variable, global variable masked by local, or comparison of signed and unsigned. Many warnings are related to static code analyzer in compiler or to breaches of ISO standard detectable at compile time, which “require diagnostics”. While those occurrences may be legal in one particular case, they would be result of design issues most of time.

Some compilers, e.g. gcc, have a command line option to activate “warnings as errors” mode, it’s a nice , if cruel, tool to educate novice coders.

The Answer 18

2 people think this answer is useful

The fact that C++ compilers accept compiling code that obviously results in undefined behavior at all is a major flaw in the compilers. The reason they don’t fix this is because doing so would probably break some usable builds.

Most of the warnings should be fatal errors that prevent the build from completing. The defaults to just display errors and do the build anyway are wrong and if you don’t override them to treat warnings as errors and leave some warnings then you will likely end up with your program crashing and doing random things.

The Answer 19

-2 people think this answer is useful

You should definitely enable compiler warnings as some compilers are bad at reporting some common programming mistakes, including the following:-

-> initialise a variable gets forgotten -> return a value from a function get missed -> the simple arguments in printf and scanf families not matching the format string a function is used without being declared beforehand, though happens in c only

So as these functions can be detected and reported, just usually not by default; so this feature must be explicitly requested via compiler options.

The Answer 20

-33 people think this answer is useful

Take it easy: you don’t have to, it is not necessary. -Wall and -Werror was designed by code-refactoring maniacs for themselves: it was invented by compiler developers to avoid breaking existing builds after compiler or programming language updates on the user side. The feature is nothing, but all about the decision to break or not to break the build.

It is totally up to your preference to use it or not. I use it all the time because it helps me to fix my mistakes.

Add a Comment