diff --git a/docs/CMake.html b/docs/CMake.html index ef50f5279eb6..f6ea6668063b 100644 --- a/docs/CMake.html +++ b/docs/CMake.html @@ -25,7 +25,7 @@
@@ -41,7 +41,14 @@ the files needed by your build tool (GNU make, Visual Studio, etc) for building LLVM. -If you are really anxious +
If you are really anxious about getting a functional LLVM build, + go to the Quick start section. If you + are a CMake novice, start on Basic CMake + usage and then go back to the Quick + start once you know what you are + doing. The Options and variables section + is a reference for customizing your build. If you already have + experience with CMake, this is the recommended starting point. @@ -105,7 +112,43 @@
TODO
+This section explains basic aspects of CMake, mostly for + explaining those options which you may need on your day-to-day + usage.
+ +CMake comes with extensive documentation in the form of html + files and on the cmake executable itself. Execute cmake + --help for further help options.
+ +CMake requires to know for which build tool it shall generate + files (GNU make, Visual Studio, Xcode, etc). If not specified on + the command line, it tries to guess it based on you + environment. Once identified the build tool, CMake uses the + corresponding Generator for creating files for your build + tool. You can explicitly specify the generator with the command + line option -G "Name of the generator". For knowing the + available generators on your platform, execute
+ +cmake --help
+This will list the generator's names at the end of the help + text. Generator's names are case-sensitive. Example:
+ +cmake -G "Visual Studio 8 2005" path/to/llvm/source/root
+For a given development platform there can be more than one + adequate generator. If you use Visual Studio "NMake Makefiles" + is a generator you can use for building with NMake. By default, + CMake chooses the more specific generator supported by your + development environment. If you want an alternative generator, + you must tell this to CMake with the -G option.
+ +TODO: explain variables and cache. Move explanation here from + #options section.
LLVM testing is not supported on Visual Studio.
+TODO