[Botan-devel] include directory convention

Christophe Meessen meessen at cppm.in2p3.fr
Mon Jul 2 11:54:39 EDT 2007


Hello,

When dealing with big projects with various packages (i.e. botan) there
is a risk of include file name conflict with other packages.  Such type
of conflicts are usually  avoided by storing include files in a
subdirectory named as the package.

So instead of including "dh.h" file, one includes "botan/dh.h".

In the current include file organisation, one could have an include file
conflict if the user has a dh.h include file too.

The suggested change would yield the following include file organisation:

include/
           botan.h
           botan/
                     adler.h
                     aes.h
                     ...

All include directives in the botan package would have to be changed
into #include "botan/...". Since the botan.h is left where it is, user
code will not be broken by the change.

I guess this type of change is for 1.7.x




More information about the botan-devel mailing list