X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/981a6271009dbf06a78440f70ffb433a4e9bcedb..d11e8786ed13b72766eea18cb577cc00f9f08f41:/include/wx/build.h

diff --git a/include/wx/build.h b/include/wx/build.h
index 9b0413b91c..4cc0dca46d 100644
--- a/include/wx/build.h
+++ b/include/wx/build.h
@@ -14,6 +14,19 @@
 
 #include "wx/version.h"
 
+// NB: This file contains macros for checking binary compatibility of libraries
+//     in multilib buildm, plugins and user components.
+//     The WX_BUILD_OPTIONS_SIGNATURE macro expands into string that should
+//     uniquely identify binary compatible builds: i.e. if two builds of the
+//     library are binary compatible, their signature string should be the
+//     same; if two builds are binary incompatible, their signatures should
+//     be different.
+//
+//     Therefore, wxUSE_XXX flags that affect binary compatibility (vtables,
+//     function signatures) should be accounted for here. So should compilers
+//     and compiler versions (but note that binary compatible compiler versions
+//     such as gcc-2.95.2 and gcc-2.95.3 should have same signature!).
+
 // ----------------------------------------------------------------------------
 // WX_BUILD_OPTIONS_SIGNATURE
 // ----------------------------------------------------------------------------
@@ -81,7 +94,7 @@
 #else
     #define __WX_BO_STL ",wx containers"
 #endif
- 
+
 // This macro is passed as argument to wxConsoleApp::CheckBuildOptions()
 #define WX_BUILD_OPTIONS_SIGNATURE \
     __WX_BO_VERSION(wxMAJOR_VERSION, wxMINOR_VERSION, wxRELEASE_NUMBER) \