[jira] [Created] (DISPATCH-836) Source file organization suffers from include hell

["Chuck Rolke (JIRA)" <ji...@apache.org>]

Chuck Rolke created DISPATCH-836:
------------------------------------

             Summary: Source file organization suffers from include hell
                 Key: DISPATCH-836
                 URL: https://issues.apache.org/jira/browse/DISPATCH-836
             Project: Qpid Dispatch
          Issue Type: Improvement
          Components: Container, Router Node, Routing Engine
    Affects Versions: 0.8.0
            Reporter: Chuck Rolke
            Priority: Minor


Adding an innocent looking #include to some module may unleash a barrage of errors instead of simply defining the header's interface. Reordering and/or adding more #include statements is required to get it right.

A good way to address this is to make certain that each module.h file compiles cleanly on its own. It is tedious and pretty unrewarding to check each file. One strategy to address this problem is for each module to _#include module.h_ as the first include\[1\]. Then every compile checks that the module.h files compiles cleanly. This strategy is recommended by astitcher and used by qpid-cpp with great results.

\[1\] One exception to this rule is including the #include Python.h ahead of all others. This is a requirement.



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@qpid.apache.org
For additional commands, e-mail: dev-help@qpid.apache.org