summaryrefslogtreecommitdiffstats
path: root/release_docs/INSTALL_Warnings.txt
blob: 97981be5ba6aeeffed139c7ad07ae24872c37dde (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
***********************************************************************
*                       COMPILER WARNINGS OPTIONS
***********************************************************************

                     Table of Contents

Section I:    Managing Warnings
Section II:   Default Warnings
Section III:  All Warnings
Section IV:   Group 0 Warnings
Section V:    Group 1 Warnings
Section VI:   Group 2 Warnings
Section VII:  Group 3 Warnings
Section VIII: Group 4 Warnings
Section IX:   Disable Warnings

************************************************************************


========================================================================
I. Managing Warnings
========================================================================
Compiler warnings are managed by setting the compiler flags variables.

Autotools uses the H5_CFLAGS and H5_CXXFLAGS, both variables set the flags nearly
  identical, along with H5_FCFLAGS for Fortran. Autotools uses the type
  and version of the compiler to determine which warning flags are used.
  However, there is an option, enable-developer-warnings, to enable extra
  flags for developers.

CMake uses the CMAKE_C_FLAGS and CMAKE_CXX_FLAGS, both sets are nearly
  identical, along with CMAKE_Fortran_FLAGS for Fortran. CMake has a
  minimum set of flags for GNU type compilers and for MSVC compilers. In
  addition, CMake breaks the list of flags into groups. The groups for
  GNU are roughly associated with the version of the compiler, while
  the MSVC groups are associated with the warning levels for the
  Microsoft compilers. The CMake option for enabling extra developer
  warnings is HDF5_ENABLE_DEV_WARNINGS.

Custom settings can be used by setting;
  Environment variables H5_CFLAGS and H5_CXXFLAGS for Autotools
  CMake defines CMAKE_C_FLAGS and CMAKE_CXX_FLAGS for CMake


========================================================================
II. Default Warnings
========================================================================

--------------------------------------------------
Autotools UNIX warnings added to H5_CFLAGS
--------------------------------------------------
    -std=c99

   the following warning switches should not raise warnings by the current code
    -pedantic
    -Wall
    -Wextra
    -Wbad-function-cast
    -Wc++-compat
    -Wcast-align
    -Wcast-qual
    -Wconversion
    -Wdisabled-optimization
    -Wfloat-equal
    -Wformat=2
    -Winit-self
    -Winvalid-pch
    -Wmissing-declarations
    -Wmissing-include-dirs
    -Wmissing-prototypes
    -Wnested-externs
    -Wold-style-definition
    -Wpacked
    -Wpointer-arith
    -Wredundant-decls
    -Wshadow
    -Wstrict-prototypes
    -Wswitch-default
    -Wswitch-enum
    -Wundef
    -Wunused-macros
    -Wunsafe-loop-optimizations
    -Wwrite-strings

   enable-developer-warnings=ON
        -Winline
        -Waggregate-return
        -Wmissing-format-attribute
        -Wmissing-noreturn
        -Wunsuffixed-float-constants (gcc 4.5+)
   enable-developer-warnings=OFF
        -Wno-inline
        -Wno-aggregate-return
        -Wno-missing-format-attribute
        -Wno-missing-noreturn
        -Wno-unsuffixed-float-constants (gcc 4.5+)

IF GCC <= 4.3
    -Wno-long-long
    -Wvolatile-register-var
    -Wstrict-overflow

IF GCC <= 4.4
    -Wno-long-long
    -Wvolatile-register-var
    -Wstrict-overflow
    -Wlogical-op
    -Wvla

IF GCC <= 4.5
    -Wno-long-long
    -Wvolatile-register-var
    -Wstrict-overflow
    -Wlogical-op
    -Wvla
    -Wlarger-than=2048
    -Wsync-nand
    -Wframe-larger-than=16384
    -Wpacked-bitfield-compat

IF GCC <= 4.6
    -Wno-long-long
    -Wlogical-op
    -Wvla
    -Wlarger-than=2048
    -Wsync-nand
    -Wframe-larger-than=16384
    -Wpacked-bitfield-compat
    -Wstrict-aliasing
    -Wstrict-overflow=5
    -Wjump-misses-init

IF GCC <= 4.7
    -Wno-long-long
    -Wlogical-op
    -Wvla
    -Wlarger-than=2048
    -Wsync-nand
    -Wframe-larger-than=16384
    -Wpacked-bitfield-compat
    -Wstrict-aliasing
    -Wstrict-overflow=5
    -Wjump-misses-init
    -Wdouble-promotion
    -Wtrampolines
   enable-developer-warnings=ON:
        -Wsuggest-attribute=const
   enable-developer-warnings=OFF:
        -Wno-suggest-attribute=const

IF GCC <= 4.8
    -Wlogical-op
    -Wvla
    -Wlarger-than=2048
    -Wsync-nand
    -Wframe-larger-than=16384
    -Wpacked-bitfield-compat
    -Wstrict-overflow=5
    -Wjump-misses-init
    -Wdouble-promotion
    -Wtrampolines
    -Wstack-usage=8192
    -Wvector-operation-performance
   enable-developer-warnings=ON:
        -Wsuggest-attribute=const
        -Wsuggest-attribute=pure
        -Wsuggest-attribute=noreturn
   enable-developer-warnings=OFF:
        -Wno-suggest-attribute=const
        -Wno-suggest-attribute=pure
        -Wno-suggest-attribute=noreturn

IF GCC <= 4.9
    -Wlogical-op
    -Wvla
    -Wlarger-than=2048
    -Wsync-nand
    -Wframe-larger-than=16384
    -Wpacked-bitfield-compat
    -Wstrict-overflow=5
    -Wjump-misses-init
    -Wdouble-promotion
    -Wtrampolines
    -Wstack-usage=8192
    -Wvector-operation-performance
   enable-developer-warnings=ON:
        -Wsuggest-attribute=const
        -Wsuggest-attribute=pure
        -Wsuggest-attribute=noreturn
        -Wsuggest-attribute=format
   enable-developer-warnings=OFF:
        -Wno-suggest-attribute=const
        -Wno-suggest-attribute=pure
        -Wno-suggest-attribute=noreturn
        -Wno-suggest-attribute=format

IF GCC < 5
    -Wlogical-op
    -Wvla
    -Wlarger-than=2048
    -Wsync-nand
    -Wframe-larger-than=16384
    -Wpacked-bitfield-compat
    -Wstrict-overflow=5
    -Wjump-misses-init
    -Wdouble-promotion
    -Wtrampolines
    -Wstack-usage=8192
    -Wvector-operation-performance
    -Wdate-time
   enable-developer-warnings=ON:
        -Wsuggest-attribute=const
        -Wsuggest-attribute=pure
        -Wsuggest-attribute=noreturn
        -Wsuggest-attribute=format
   enable-developer-warnings=OFF:
        -Wno-suggest-attribute=const
        -Wno-suggest-attribute=pure
        -Wno-suggest-attribute=noreturn
        -Wno-suggest-attribute=format

IF GCC < 6
    -Wlogical-op
    -Wvla
    -Wlarger-than=2048
    -Wsync-nand
    -Wframe-larger-than=16384
    -Wpacked-bitfield-compat
    -Wstrict-overflow=5
    -Wjump-misses-init
    -Wdouble-promotion
    -Wtrampolines
    -Wstack-usage=8192
    -Wvector-operation-performance
    -Wdate-time
    -Warray-bounds=2
    -Wc99-c11-compat
   enable-developer-warnings=ON:
        -Wsuggest-attribute=const
        -Wsuggest-attribute=pure
        -Wsuggest-attribute=noreturn
        -Wsuggest-attribute=format
   enable-developer-warnings=OFF:
        -Wno-suggest-attribute=const
        -Wno-suggest-attribute=pure
        -Wno-suggest-attribute=noreturn
        -Wno-suggest-attribute=format

IF GCC < 7
    -Wlogical-op
    -Wvla
    -Wlarger-than=2048
    -Wsync-nand
    -Wframe-larger-than=16384
    -Wpacked-bitfield-compat
    -Wstrict-overflow=5
    -Wjump-misses-init
    -Wdouble-promotion
    -Wtrampolines
    -Wstack-usage=8192
    -Wvector-operation-performance
    -Wdate-time
    -Warray-bounds=2
    -Wc99-c11-compat
    -Wnull-dereference
    -Wunused-const-variable
    -Wduplicated-cond -Whsa
   enable-developer-warnings=ON:
        -Wsuggest-attribute=const
        -Wsuggest-attribute=pure
        -Wsuggest-attribute=noreturn
        -Wsuggest-attribute=format
   enable-developer-warnings=OFF:
        -Wno-suggest-attribute=const
        -Wno-suggest-attribute=pure
        -Wno-suggest-attribute=noreturn
        -Wno-suggest-attribute=format


--------------------------------------------
CMake warnings added to CMAKE_C_FLAGS
--------------------------------------------

IF GNU GCC
    -pedantic
    -Wall
    -Wextra
    -Wbad-function-cast
    -Wc++-compat
    -Wcast-align
    -Wcast-qual
    -Wconversion
    -Wdisabled-optimization
    -Wfloat-equal
    -Wformat=2
    -Winit-self
    -Winvalid-pch
    -Wmissing-declarations
    -Wmissing-include-dirs
    -Wmissing-prototypes
    -Wnested-externs
    -Wold-style-definition
    -Wpacked
    -Wpointer-arith
    -Wredundant-decls
    -Wshadow
    -Wstrict-prototypes
    -Wswitch-default
    -Wswitch-enum
    -Wundef
    -Wunused-macros
    -Wunsafe-loop-optimizations
    -Wwrite-strings

    -fmessage-length=0
   HDF5_ENABLE_DEV_WARNINGS=ON
        -Winline
        -Waggregate-return
        -Wunsuffixed-float-constants (gcc 4.5+)
   HDF5_ENABLE_DEV_WARNINGS=OFF
        -Wno-unused-parameter
        -Wno-inline
        -Wno-aggregate-return
        -Wno-unsuffixed-float-constants (gcc 4.5+)


========================================================================
III. All Warnings in CMake
========================================================================

Default: HDF5_ENABLE_DEV_WARNINGS:BOOL=OFF
    For Visual Studio:
        /W3

HDF5_ENABLE_ALL_WARNINGS:BOOL=ON
    For Visual Studio:
        /Wall
        /wd4668

    For GNU GCC
        Group 0 flags
        Group 1 flags
        Group 2 flags


========================================================================
IV. Group 0 Warnings in CMake
========================================================================

Default: HDF5_ENABLE_GROUPZERO_WARNINGS:BOOL=OFF

HDF5_ENABLE_GROUPZERO_WARNINGS:BOOL=ON
    For Visual Studio
        /W1

    For GNU GCC
        Default Warnings


========================================================================
V. Group 1 Warnings in CMake
========================================================================

Default: HDF5_ENABLE_GROUPONE_WARNINGS:BOOL=OFF

HDF5_ENABLE_GROUPONE_WARNINGS:BOOL=ON
    For Visual Studio
        /W2

    For GNU GCC
      IF GCC >= 4.3
        -Wlogical-op
        -Wvla
        -Wlarger-than=2048
      IF GCC >= 4.4
        -Wsync-nand
        -Wframe-larger-than=16384
        -Wpacked-bitfield-compat
      IF GCC >= 4.5
        -Wstrict-overflow=5
        -Wjump-misses-init


========================================================================
VI. Group 2 Warnings in CMake
========================================================================

Default: HDF5_ENABLE_GROUPTWO_WARNINGS:BOOL=OFF

HDF5_ENABLE_GROUPTWO_WARNINGS:BOOL=ON
    For Visual Studio
        /W3

    For GNU GCC
      IF GCC >= 4.6
        -Wdouble-promotion
        -Wtrampolines
       enable-developer-warnings=ON:
            -Wsuggest-attribute=const
       enable-developer-warnings=OFF:
            -Wno-suggest-attribute=const
      IF GCC >= 4.7
        -Wstack-usage=8192
        -Wvector-operation-performance
       enable-developer-warnings=ON:
            -Wsuggest-attribute=pure
            -Wsuggest-attribute=noreturn
       enable-developer-warnings=OFF:
            -Wno-suggest-attribute=pure
            -Wno-suggest-attribute=noreturn
      IF GCC >= 4.8
       enable-developer-warnings=ON:
            -Wsuggest-attribute=format
       enable-developer-warnings=OFF:
            -Wno-suggest-attribute=format
      IF GCC >= 4.8
        -Wdate-time


========================================================================
VII. Group 3 Warnings in CMake
========================================================================

Default: HDF5_ENABLE_GROUPTHREE_WARNINGS:BOOL=OFF

HDF5_ENABLE_GROUPTHREE_WARNINGS:BOOL=ON
    For Visual Studio
        /W4

    For GNU GCC
        IF GCC >= 5.1
            -Warray-bounds=2
            -Wc99-c11-compat


========================================================================
VIII. Group 4 Warnings in CMake
========================================================================

Default: HDF5_ENABLE_GROUPFOUR_WARNINGS:BOOL=OFF

HDF5_ENABLE_GROUPFOUR_WARNINGS:BOOL=ON
    For GNU GCC
        IF GCC >= 6.0
            -Wnull-dereference
            -Wunused-const-variable
            -Wduplicated-cond
            -Whsa


========================================================================
IX. Disable Warnings in CMake
========================================================================

Default: HDF5_DISABLE_COMPILER_WARNINGS:BOOL=OFF

HDF5_DISABLE_COMPILER_WARNINGS:BOOL=ON
    For Visual Studio
        HDF5_WARNINGS_BLOCKED:BOOL=ON
        /W0

    For GNU GCC
        -w


========================================================================
For further assistance, send email to help@hdfgroup.org
========================================================================