From 300e37fef74069875428716b3d32153dd4195f79 Mon Sep 17 00:00:00 2001 From: click Date: Tue, 14 Dec 2010 19:34:19 +0100 Subject: [PATCH] Docs: Add a small info about how to report compilation errors, AND inform how to properly "hunt" for the error. --HG-- branch : trunk --- doc/COMPILATION_HELP.TXT | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 doc/COMPILATION_HELP.TXT diff --git a/doc/COMPILATION_HELP.TXT b/doc/COMPILATION_HELP.TXT new file mode 100644 index 0000000000..9345a4bf5e --- /dev/null +++ b/doc/COMPILATION_HELP.TXT @@ -0,0 +1,31 @@ +NOTE TO USERS WITH COMPILE-ERRORS : + +Before commenting on our issuetracker that "it doesn't compile", we ask you +to do the following : + +* Clear the CMake cache + + In certain cases we adjust and modify the buildsystem (adding/removing + functions/functionality. + +* Remove/delete and recreate your build directory, and recompile + + In most cases any linking-errors are related to that the build- + system has not caught up with specific changes. + +* Compile on a CLEAN sourcetree + + We can not, for obvious reasons, support cores that has been modified. + As you might understand, we're not psychics: we're not aware of what + you have done to your sourcetree, and as such : We can't see what your + additional code is like. + +* SUPPLY PROPER LOGS ON COMPILE-ERRORS + + This means: Add as MUCH info as possible to the issue, including the + full log from the compile itself (or at least include the 20 lines + above AND under the compile-error itself). + +Happy compiling, and have a nice day! + +-- The TrinityCore developers