[SDK] One step further towards ReactOS source code tree restructure: the sdk folder...
[reactos.git] / reactos / lib / 3rdparty / stlport / doc / README.msvc
diff --git a/reactos/lib/3rdparty/stlport/doc/README.msvc b/reactos/lib/3rdparty/stlport/doc/README.msvc
deleted file mode 100644 (file)
index 1cc80e1..0000000
+++ /dev/null
@@ -1,186 +0,0 @@
-\r
-==================================================\r
-STLport README for Microsoft Visual C++ compilers.\r
-==================================================\r
-\r
-by: Francois Dumont, dums@stlport.com, last edited 08/02/2005\r
-\r
-============\r
-Introduction\r
-============\r
-This document describes how STLport can be compiled and used with Microsoft\r
-Visual C++ 6 SP5. It can also be used for the MSVC++ family.\r
-\r
-For any further comments or questsion visit STLport mailing lists\r
-http://stlport.sourceforge.net/Maillists.shtml or forums\r
-https://sourceforge.net/forum/?group_id=146814\r
-\r
-=============\r
-Prerequisites\r
-=============\r
-To build and use STLport you will need following tools and libraries:\r
- - Microsoft Visual C++ 6.0 with at least Service Pack 5 or any higher\r
- version.\r
-\r
-===================\r
-Configuring STLport\r
-===================\r
-In a console window go to the STLport build/lib folder. Run\r
-\r
-       configure --help\r
-\r
-This command will present you the different available build options. Just follow\r
-the instructions to set STLport configuration according your needs. The only\r
-mandatory configuration is to declare what is the compiler you are going to\r
-use, for MSVC 6 it is:\r
-\r
-       configure -c msvc6\r
-\r
-================\r
-Building STLport\r
-================\r
-This is a step by step description of the actions to take in order to have\r
-the STLport library built:\r
-\r
-1. Open a console window. You can get it executing cmd or command depending\r
-on your Windows OS.\r
-\r
-2. Go to MSVC++ Bin directory with a default MSVC6 install it is\r
-       cd "C:\Program Files\Microsoft Visual Studio\VC98\Bin"\r
-\r
-3. Run the vcvars32.bat script. This sets the environment variables required\r
-to have the MSVC++ compiler run during the build process. The most important\r
-one is the PATH variable so that you can call the cl.exe command which is the\r
-MSVC++ command line compiler. [You may omit this step, if you chose 'Install paths\r
-to access command-line tools' during Microsoft Visual Studio installation procedure.]\r
-\r
-4. Go to the STLport build/lib folder:\r
-       cd C:\STLport\build\lib\r
-\r
-5. Run the following command:\r
-       nmake /fmsvc.mak install\r
-\r
-       nmake is the make utility from Microsoft. /f is an nmake option\r
-telling it which make file script to use. You have of course to grant the \r
-closer make file to your effective compiler, msvc.mak in our case.\r
-\r
-       Once the command returns, you will have all the necessary libraries within\r
-the STLport lib folder. For a description of the generated libraries check the README\r
-file within the src folder.\r
-\r
-===============\r
-Testing STLport\r
-===============\r
-You can use the unit tests to verify STLport behaves correctly. Change into\r
-STLports 'build/test/unit' folder and type:\r
-\r
-  nmake /fmsvc.mak install\r
-\r
-Once the unit test is built you just need to run it. They can be found\r
-within the STLport bin folder.\r
-\r
-=============\r
-Using STLport\r
-=============\r
-Adjust your include and link paths in MSVC IDE (in 'Tools -> Options -> Directories'\r
-for MSVC6 IDE). In the include files add the path to STLport's 'stlport' folder. \r
-Make sure it is the first directory listed there. Add STLport's 'lib' folder for\r
-the library files (order of paths doesn't matter here).\r
-\r
-There are some preprocessor defines that control usage of the STLport in msvc\r
-projects:\r
-\r
-If you don't want to use the iostreams part of the library, you can specify the\r
-define _STLP_NO_IOSTREAMS. In this mode there is no need to link against the\r
-library.\r
-\r
-STLport uses automatic linking to find the proper .lib file. If you want to see\r
-what import library STLport is going to use, define _STLP_VERBOSE_AUTO_LINK.\r
-When not using automatic linking (by specifying _STLP_DONT_USE_AUTO_LINK), you\r
-have to specify the proper .lib file in the Project Settings, on the "link" tab.\r
-The .lib names have the following syntax:\r
-\r
-   stlport[d|stld][_x,_static,_statix].<STLport-Version>.lib\r
-\r
-   d : debug build\r
-   stld: debug build with _STLP_DEBUG (STL safe) mode\r
-   _x: Build of STLport as a dll but statically link to the native runtime.\r
-   _static : build of a static library\r
-   _statix : build of a static library link dynamically to the native runtime.\r
-   \r
-Examples:\r
-\r
-   stlport_static.5.0.lib - static release version, Version 5.0.0\r
-   stlportd.5.0.lib - dll debug version, Version 5.0.0\r
-\r
-When using STLport together with MFC, be sure to include the MFC headers first,\r
-then include STLport headers, e.g. in your Stdafx.h. This way STLport correctly\r
-recognizes MFC usage. You also can define the macro _STLP_USE_MFC, either in\r
-your project settings or in stlport/stl/config/user_config.h.\r
-\r
-In order to enhance debugging with STLport you can optionally add the content of\r
-the etc/autoexp.dat file in the autoexp.dat file coming with your Visual Studio\r
-install.\r
-\r
-Now you should be ready to use STLport.\r
-\r
-============\r
-Known issues\r
-============\r
-\r
-1. InterlockedIncrement\r
-\r
-       If you experiment trouble with the InterlockedIncrement Win32 API function\r
-like the following message:\r
-\r
-C:\Program Files\Microsoft SDK\Include\.\winbase.h(1392) : error C2733: second C\r
-linkage of overloaded function 'InterlockedIncrement' not allowed\r
-C:\Program Files\Microsoft SDK\Include\.\winbase.h(1390) : see declaration of\r
-'InterlockedIncrement'\r
-\r
-       It means that you are using the new Microsoft platform SDK. There is no\r
-way to known it from STLport code so you have to signal it in the \r
-stlport/stl/config/user_config.h file (uncomment _STLP_NEW_PLATFORM_SDK in this file).\r
-\r
-2. Native C/C++ library headers location\r
-\r
-       If you experiment trouble with location of ctime and other Standard headers\r
-while building or using STLport you might be using the compiler coming with a\r
-platform SDK. If so please uncomment _STLP_USING_PLATFORM_SDK_COMPILER in\r
-stlport/stl/config/user_config.h. If it still do not find native headers you will\r
-perhaps need to change native headers relative path used by STLport. In this case use\r
-_STLP_NATIVE_INCLUDE_PATH and associated macro in stlport/stl/config/host.h.\r
-\r
-4. C symbols in std namespace\r
-\r
-The compiler of MSVC++ 6 has a bug when dealing with symbols existant in both\r
-the global namespace and symbols imported by a using-directive or a \r
-using-declaration - it will report an ambiguous call to an overloaded\r
-function (error C2668). Example:\r
-\r
-void function();\r
-namespace ns {\r
-   void function();\r
-   // or:\r
-   // using ::function;\r
-}\r
-\r
-using ns::function;\r
-// or:\r
-// using namespace ns;\r
-\r
-void call() {\r
-   function();\r
-}\r
-\r
-Since we anticipate that using-declarations or even using-directives are common\r
-use, STLport by default doesn't import or wrap functions that exist in both the\r
-global namespace and namespace std, in particular those are functions with C \r
-origin like fopen() or abs(). Also, it defines additional overloads for\r
-functions like abs() (overloaded for int, long, float, double, long double) in\r
-the global namespace.\r
-\r
-In order to make STLport include them in the std namespace, you can define the\r
-_STLP_DO_IMPORT_CSTD_FUNCTIONS macro. Doing so, you will have to explicitely \r
-scope all your functions calls like std::abs() though - otherwise you only get\r
-the global abs(int) from the C library.\r