CMake is a cross-platform build system. For ReactOS it is used as a high level generator for the low level build systems ninja or make(deprecated).
The CMake executable comes with the ReactOS Build Environment; for both environments (Windows NT-compatible OS Version 2.1.5 and Unix-compatible Operating Systems Version 2.1.2) as version v3.2.1 (see README.pdf: Unix Environment).
The initial call to CMake comes from the configure script (win, Unix). Afterwards the generated low level build script contains a call to CMake in the first place. Thus whenever ninja (or (n)make) is called then CMake searches first for changes in the CMake configuration scripts and generates a new ninja (or (n)make) script if necessary.
- 1 Weblinks
- 2 History
- 3 Building with CMake
- 3.1 Preparing the Build Environment
- 3.2 Precompiled Headers Support (PCH)
- 3.3 Preparing the Output Location
- 3.4 Building Tools
- 3.5 Building ReactOS
- 3.6 See also
- Project website: https://cmake.org/
- Documentation: https://cmake.org/documentation/
- Description of cmake-buildsystem version 3.2: https://cmake.org/cmake/help/v3.2/manual/cmake-buildsystem.7.html
- Tutorial: https://cmake.org/cmake-tutorial/
- Wikipedia article: https://en.wikipedia.org/wiki/CMake
Since revision r51836, trunk can be built using cmake.
Building with CMake
|Notice: This section is deprecated and is purely here for archival purposes. For instructions on building ReactOS, please see the Build Environment page of the development guide.|
Preparing the Build Environment
First you need to download and install the ReactOS Build Environment.
Precompiled Headers Support (PCH)
For reduced build time, Precompiled Headers Support was introduced. Next you should enable this feature in ReactOS CMake configure script (configure.cmd/configure.sh) by changing -DPCH=0 to -DPCH=1.
Preparing the Output Location
Before building either the tools or ReactOS itself the output location must be created and prepared. This is an easy step and involves only one command. This command is located in the root of recent revisions of the source code and can be run either from the root directory itself or any other directory you want the build your sources in.
Both MinGW and Microsoft Visual C++ compiler (versions 2010 and above) is supported. Command is very similar with slightly different output location.
After executing, folder output-MinGW-i386 will be created in root of ReactOS tree. You will be redirected to it.
Visual Studio and Microsoft Visual C++ (2010+)
To prepare the location for use with Visual Studio or Microsoft Visual C++:
- Open a Windows DDK/WDK/Visual Studio command prompt.
- There are two methods to compile using Microsoft Visual C++.
- If you prefer older method of building, just configure as usual:
- To generate Visual Studio solution files instead, using the following command:
After executing, folder output-VS-i386 will be created in root of ReactOS tree. You will be redirected to it.
To build the branch, build tools must be compiled first. This only needs to be done for the first build and whenever there is a change to the build tools.
From your output directory, go to host-tools. Follow specific instruction for your compiler.
Visual Studio or Microsoft Visual C++
If you are using Visual Studio or Microsoft Visual C++ (and you executed configure.cmd VSSolution earlier from DDK/WDK/VS command prompt), use msbuild instead of make (there are few solutions/projects in folder so you must specify solution/project name after msbuild):
If you have problems with building things from command line go here. This must help.
And of course you can use IDE with GUI instead of doing this in command line. If you still have questions go here
If you want to build ReactOS with both nmake and msbuild you need to create another folder for one of them (because by default configure.cmd creates output-VS9-i386 for both and files will be mixed). For example to use for nmake build folder output-VS9nmake-i386 you need to do next:
To generate Visual Studio solution files too, create another folder, because by default, configure.cmd uses the same folder name, which leads to mixed files. For example to use for nmake build folder output-VS10nmake-i386 you should do the following:
mkdir output-VS-nmake-i386 cd output-VS-nmake-i386 ..\configure.cmd
And then build host tools as usual:
cd host-tools nmake cd ..
With the build tools compiled, ReactOS can now be compiled. In the case of CMakeLists being updated it is best to remove the content of the build-ros folder and rebuild ReactOS.
cd reactos ninja
Combining the above steps together:
configure.cmd cd host-tools ninja cd ../reactos ninja
To build a specific module (i.e: "win32k") you can follow the next steps: Building Modules
Building ReactOS with nmake/msbuild
If you want to build ReactOS with nmake you can receive such error during building
'mc' is not recognized as an internal or external command,operable program or batch file.
Seems you are using Microsoft Visual C++ Express Edition. Go here for getting info and working around the issue. It might also be possible to use "windmc" from MinGW binutils as an alternative implementation of MC.exe.
Building Modules much Faster (CMake feature)
|Notice: The following syntax can be used just with CMake.|
CMake implements a feature that can speed up the modules building process using the Fast syntax. You can use the Fast syntax if your changes just affects one module and does not change any code of others modules that the Desired module depends on. This /fast syntax skips dependency checking before compiling starts, so it is terrible fast.
|Notice: You need at least to have compiled the desired module once with "make Desired_module " before using the Fast syntax.|
One simple example: You have changed just some "win32k" code (desired module) but you did not change any module that the desired module depends on (i.e,the PSDK headers), you have also the "Win32k-before-changes" module compiled, then you can use the Fast syntax to compile the new "win32k" module in few seconds.
Warning: The Fast syntax just will look for changes in the Desired module, not checking if any other modules have been modified.
The Fast syntax to build any module is:
If you want to compile Win32k, it would be:
Building a Bootcd
To build a bootcd you can follow the next steps: Building ReactOS
Building a bootcd much Faster
NOTE: This method is just available with CMake.
Thanks to Fast syntax,creating a bootcd is much faster. Before compiling bootcd with Fast syntax you have to be sure that any Dependent module has been compiled previously. "/Fast" skips dependency checking before compiling starts.
Remember: You need at least to have compiled the Desired module once with "make Desired_module " before using the bootcd Fast syntax. Read Building Modules much Faster for more info.
An example: "You have added some changes in win32k module and now you want a bootcd with your new modified win32k.You have,also, the "win32k-before-changes" compiled."
as your changes are just related to win32k.
Read the following carefully:
It's mandatory to compile at least once with "make bootcd" before using the Fast syntax. It's mandatory to compile the module changes before invoking bootcd/fast, otherwise your changes won't be added. If your changes are modifying modules that win32k depends on, you should use "make win32k" and then invoke "make bootcd/fast" instead. If your changes are modifying several INDEPENDENT modules, compile all of them with Fast syntax and afterwards a perform a bootcd/fast compilation. This method becomes less practical when you alter many modules.