OpenSAF / Tickets / #2449 osaf: Avoid conditional compilation when possible

#2449 osaf: Avoid conditional compilation when possible

Milestone: future

Status: assigned

Owner: Anders Widell

Labels: None

Type: enhancement

Component: osaf

Part: -

Version:

Priority: major

Blocker: False

Updated: 2019-07-23

Created: 2017-05-03

Creator: Anders Widell

Private: No

Related to ticket [#2448]. OpenSAF currently has a number of C preprocessor macros that control conditional compilation using #ifdef in the source code. This has a number of problems:

It makes testing more complex - we need to create one OpenSAF build for each possible combination of enabled/disabled macros and test each build.
ifdefs can confuse static code analysis tools - and humans as well.
This can make it impossible to choose at installation time which OpenSAF RPMs to install on the system, see ticket [#2448].

This ticket suggests that conditional compilation shall be removed when possible. One possible exception could be an OSAF_ENABLE_DEBUG macro that can create a separate debug build of OpenSAF. A debug build has some benefits for testing and trouble shooting but shouldn't be installed on a production system.

Description has changed:

Diff:

--- old
+++ new
@@ -1,7 +1,7 @@
 Related to ticket [#2448]. OpenSAF currently has a number of C preprocessor macros that control conditional compilation using #ifdef in the source code. This has a number of problems:

 * It makes testing more complex - we need to create one OpenSAF build for each possible combination of enabled/disabled macros and test each build.
-* #ifdefs can confuse static code analysis tools - and humans as well.
+* ifdefs can confuse static code analysis tools - and humans as well.
 * This can make it impossible to choose at installation time which OpenSAF RPMs to install on the system, see ticket [#2448].

 This ticket suggests that conditional compilation shall be removed when possible. One possible exception could be an OSAF_ENABLE_DEBUG macro that can create a separate debug build of OpenSAF. A debug build has some benefits for testing and trouble shooting but shouldn't be installed on a production system.

Tickets: #2448

Anders Widell - 2017-07-01

Milestone: 5.17.08 --> 5.17.10
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Anders Widell - 2017-10-30

Milestone: 5.17.10 --> 5.18.01
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Anders Widell - 2018-02-02

Milestone: 5.18.01 --> 5.18.04
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Anders Widell - 2018-04-20

Milestone: 5.18.04 --> 5.18.06
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Gary Lee - 2018-06-29

Milestone: 5.18.06 --> 5.18.08
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Gary Lee - 2018-09-29

Milestone: 5.18.09 --> 5.18.12
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Gary Lee - 2019-01-09

Milestone: 5.19.01 --> 5.19.03
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Gary Lee - 2019-03-26

Milestone: 5.19.03 --> 5.19.06
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Gary Lee - 2019-07-23

Milestone: 5.19.07 --> future
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

osaf: Avoid conditional compilation when possible

Milestone

Searches

Help

#2449 osaf: Avoid conditional compilation when possible

Related

Discussion

Related