Difference between revisions of "Building ReactOS"

From ReactOS Wiki
Jump to: navigation, search
(→‎Building ReactOS)
m (→‎*nix: Add `./` to beginning of configure command.)
 
(68 intermediate revisions by 35 users not shown)
Line 1: Line 1:
−
This page describes the steps necessary to build ReactOS.
+
This page describes the steps necessary to build ReactOS.<br>
 +
ReactOS supports building on different operating systems and with different compilers.
 +
Currently GCC, MSVC and LLVM/Clang can be used.
  
−
== Getting all you need ==
+
The build process differs depending your operating system and the compiler of choice.<br>
 +
Each build step in the tutorial is separated by OS/compiler when necessary. Choose ones which fit your configuration.
  
−
=== Getting a Working Copy ===
+
== Which compiler to use ==
 +
* GCC is currently a recommended option as the most simple to use.
 +
* MSVC compiler can be used for better debugging capabilities (only MSVC builds support windbg debugger).
 +
* Clang support is currently experimental and not advised unless you know what are you doing.
  
−
The first step in building ReactOS is getting a copy of the source code.
+
== Prerequisites ==
 +
* A PC with at least 2GB of RAM (4GB preferred), 15GB of free space.
 +
* Git version control system.
 +
* [[ReactOS Build Environment]] (RosBE). Please, always use the latest version available.
 +
* (optional) [https://visualstudio.microsoft.com/downloads/ Microsoft Visual Studio] 2015 or later (or Build Tools for Visual Studio).
 +
* (optional) [https://releases.llvm.org/ LLVM toolchain] 12.0.0 or later.
  
−
You can use the exported release source code, but since you are reading this, you are probably interested in keeping up to date with the latest changes, so you will want a "working copy" of ReactOS.  
+
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
−
To get a working copy of ReactOS, please read the [[Subversion]] page.
+
<div style="font-weight:bold;line-height:1.6;">Visual Studio installation remarks</div>
 +
<div class="mw-collapsible-content">
 +
* Download the Visual studio 2017 community edition (or later).
 +
: ''When selecting the options, be sure to at least include '''Desktop development with C++'''.''
 +
[[File:Desktop development.png|Desktop development]]
 +
* Ensure you have started visual studio at least once, and you are able to create a working c++ project.
 +
: ''To validate this, choose '''Create a new project''', choose '''Console App''', and use all default options.''
 +
* While installing [[RosBE]], you may choose the option '''Add BIN folder to PATH variable''' (may be added later manually).
 +
[[File:RosBE BIN folder.png]]
 +
</div></div>
  
−
=== Setting up a Build Environment ===
+
{{Notice|It is recommended to disable antivirus software before proceeding (or adding a build folder to exceptions), because some AVs may detect ReactOS' system files (in particular, crtdll.dll or csrss.exe) as being infected.}}
  
−
For building ReactOS you also need the official [[ReactOS Build Environment]]. Please download and install it from that page.
+
== TL;DR ==
 +
<syntaxhighlight lang="dos">
 +
<inside RosBE command prompt>
 +
git clone https://github.com/reactos/reactos
 +
cd reactos
 +
configure.cmd
 +
cd output-MinGW-i386
 +
ninja bootcd livecd
 +
</syntaxhighlight>
  
−
Make sure that no interfering build environment (such as MSYS) is in your PATH environment variable when building.
+
== Building instructions ==
 +
=== 1. Prepare a command prompt ===
 +
==== Windows/GCC or ReactOS/GCC ====
 +
* Just use the RosBE command prompt (from the Start menu)
  
−
== Prequisites ==
+
==== *nix/GCC ====
 +
* Invoke <code>RosBE.sh</code> script
  
−
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.
+
==== *nix/Clang ====
 +
* Invoke <code>RosBE.sh</code> script, ensure <code>clang</code> is available in <code>$PATH</code>
  
−
=== Linux/Unix ===
+
==== Windows/MSVC ====
−
Run:
+
* Open a Visual Studio command prompt for a desired target architecture (x86 or amd64).
  
−
configure.sh
+
* Add RosBE's <code>bin</code> folder to <code>PATH</code> (if you have not done that during the RosBE installation), like this:
 +
<syntaxhighlight lang="dos">
 +
set PATH=C:\RosBE\Bin;%PATH%
 +
</syntaxhighlight>
  
−
=== Windows ===
+
* Set the <code>M4</code> and <code>BISON_PKGDATADIR</code> environment variables:
−
Run:
+
<syntaxhighlight lang="dos">
 +
set M4=C:\RosBE\Bin\m4.exe
 +
set BISON_PKGDATADIR=C:\RosBE\share\bison
 +
</syntaxhighlight>
  
−
configure.cmd
+
'''NOTE:''' <code>C:\RosBE</code> is an example path of RosBE. You may choose a different one.
  
−
After executing, folder <tt>output-MinGW-i386</tt> will be created in root of ReactOS tree. You will be redirected to it.
+
==== Windows/Clang ====
 +
* Same as MSVC, but also ensure that <code>clang-cl.exe</code> and other LLVM tools are added to <code>PATH</code>
  
−
=== Building Tools ===
+
=== 2. Obtain the source code ===
−
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.
+
<syntaxhighlight lang="bash">
 +
  git clone https://github.com/reactos/reactos.git
 +
</syntaxhighlight>
  
−
From your output directory, go to <tt>host-tools</tt>. Follow specific instruction for your compiler.
+
=== 3. Do the "configure" step ===
 +
Before building 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. Please make sure you are running it from '''within a prepared build environment (step 1)'''.
  
−
cd host-tools
+
==== Windows or ReactOS ====
−
make
+
<syntaxhighlight lang="dos">
 +
configure.cmd [CMake generator] [Additional CMake options]
 +
</syntaxhighlight>
  
−
With the build tools compiled, ReactOS can now be compiled. In the case of <tt>CMakeLists</tt> being updated it is best to remove the content of the <tt>build-ros</tt> folder and rebuild ReactOS.
+
CMake generator is one of the following:
 +
* <code>Ninja (default)</code> use Ninja as a CMake backend
 +
* <code>VSSolution</code> use MSBuild/sln file as a CMake backend (for working with the source code inside Visual Studio)
  
 +
==== *nix ====
 +
<syntaxhighlight lang="bash">
 +
./configure.sh [Additional CMake options]
 +
</syntaxhighlight>
  
−
=== Building ReactOS ===
+
==== Additional options ====
−
cd reactos
 
−
make COMMANDS
 
  
−
Combining the above steps together:
+
Additional CMake command line options may be passed in this format: <code>-DOPTION=VALUE</code>.
 +
Available options:
  
−
configure.cmd
+
* <code>ARCH</code> target architecture. Either "i386" (default), "amd64" or "arm".
−
cd host-tools
+
* <code>SARCH</code> architecture flavor. For i386 "pc" (default), "pc98" or "xbox" values are supported
−
make
+
* <code>ENABLE_ROSTESTS</code> include tests in the build. Either "0" (default) or "1".
−
cd ../reactos
+
* <code>ENABLE_ROSAPPS</code> include extra utilities in the build. Either "0" (default) or "1".
−
make COMMANDS
+
* <code>PCH</code> enable [https://en.wikipedia.org/wiki/Precompiled_header precompiled headers] to increase the build speed. NOTE: may consume 7-15GB more space. Defaults to "1" for MSVC and "0" for GCC.
 +
* <code>USE_CLANG_CL</code> use clang-cl compiler instead of cl (only on Windows). Either "0" (default) or "1".
 +
* <code>NO_REACTOS_BUILDNO</code> do not include commit hash and date in the image. This allows to avoid recompiling the image when date changes. Either "0" (default) or "1".
  
−
In this case COMMANDS is your wanted old and known commnd, like bootcd, livecd etc.
+
So to configure an MSVC build with ninja and rosapps and rostests, you would use:
 +
<syntaxhighlight lang="dos">
 +
configure.cmd -DENABLE_ROSTESTS=1 -DENABLE_ROSAPPS=1
 +
</syntaxhighlight>
  
−
== Commands ==
+
=== 4. Start the build ===
 +
This step depends on what has been chosen as a CMake generator.
  
−
After you have started a Build Environment Command Prompt, there are certain commands available.
+
==== Ninja ====
  
−
=== Invoking a build ===
+
From the build folder (e.g. reactos\output-MinGW-i386) enter the following command:
 +
<syntaxhighlight lang="dos">
 +
ninja [targets]
 +
</syntaxhighlight>
  
−
'''make'''
+
Available targets are:
−
This command builds all binaries of ReactOS. They will be placed in the directory specified by the ROS_OUTPUT environment variable. (default: ''output-i386'')
+
* <code>bootcd</code> creates an installation ISO to install ReactOS on a VM or PC.
−
All source files, which did not change since the last build, will not be built again.
+
* <code>livecd</code> creates a live CD ISO to try ReactOS without installing.
 +
* <code>all</code> builds all binaries of ReactOS. ISO files are not created though.
 +
* <code>clean</code> cleans all files of your working copy except the generated ISO files (if any).
 +
* Any other binary file ReactOS consists of, for example <code>kernel32</code> or <code>ntoskrnl</code>
  
−
'''make bootcd'''
+
==== VSSolution (Visual Studio) ====
−
This command works like ''make'', but also generates a bootable ReactOS ISO file (''ReactOS.iso'') in the base of the working copy.
 
−
It is wise to tag your Boot-CDs with the revision they were built from if you need to keep many ReactOS ISOs.
 
  
−
'''make livecd'''
+
{{Warning|Visual Studio (VSSolution) build cannot currently produce a bootable ISOs so use it for working with individual user-mode apps (like notepad, rapps or paint). For building bootcd or livecd configuration, please use Ninja option.}}
−
This command generates ''ReactOS-LiveCD.iso'' in the base of the working copy. This is the ReactOS Live-CD that runs completely from the CD-ROM
+
''For this example we are going to see how to build [https://github.com/reactos/reactos/tree/master/base/applications/rapps rapps] from Visual Studio 2019.''
  
−
'''make install'''
+
* If configure step went well, this message should appear:
−
This command copies all the ReactOS binaries to their proper installation directory as specified in the ROS_INSTALL environment variable. (default: ''reactos'')
+
<pre>
−
 
+
Configure script complete! You can now use msbuild or open REACTOS.sln.
−
'''makex'''
+
</pre>
−
Used instead of make will utilize all physical cores on your machine.
+
* There should now be a REACTOS.sln in your build folder (Which contains ALL projects!)
−
 
+
* Since rapps has the cmake [[https://git.reactos.org/?p=reactos.git&a=search&h=HEAD&st=grep&s=project%28rapps%29 <code>project(rapps)</code>]] macro, there will also be a smaller solution just for rapps at <code>base\applications\rapps\rapps.sln</code>
−
=== Other ===
+
* Open this solution, and expand <code>base\rapplications\rapps</code>
−
 
+
* Right click rapps, choose '''Set as Startup Project'''
−
'''clean'''
+
[[File:Set as Startup Project.png]]
−
This command cleans all files of your working copy except the generated ISO files (if any). The next build you make will be completely clean then. Any parameters will recognized as module name and only this module will be cleaned then.
+
* Press '''Debug->Start Debugging''' in the menu, or the hotkey that is displayed behind it (usually <kbd>F5</kbd>)
−
 
 
−
'''remake'''
 
−
This tool cleans one or several specific modules and immediately rebuilds it cleanly.
 
−
 
 
−
'''make depmap'''
 
−
This command generates a simple dependency map for all ReactOS components.
 
−
 
 
−
'''make vreport'''
 
−
This command generates a version report for all ReactOS components, whose source files have appropriate information for that.
 
−
 
 
−
'''make world'''
 
−
This command is a shortcut for <code>make all bootcd livecd</code>
 
−
 
 
−
'''make universe'''
 
−
This command acts like <code>make world</code> but uses different debug settings and places the resulting files in separate directories.
 
−
This one is the one which creates the maximum of artefacts.
 
−
 
 
−
'''make rgenstat'''
 
−
 
 
−
'''make msbuild'''
 
−
 
 
−
'''make msbuild_clean'''
 
−
 
 
−
'''make depends'''
 
−
 
 
−
'''make makefile_auto_clean'''
 
−
 
 
−
== Adding modules to the build process ==
 
−
 
 
−
There are several modules you can add to the build process. For example ''rosapps'' contains some additional applications not included by default.
 
−
 
 
−
The page [[Building Modules]] describes, which modules exist and how to add them to the build process.
 
  
 +
== See also ==
 +
* [[Installing ReactOS]]
 +
* [[Developing ReactOS with Visual Studio]]
 +
* [[Building MINGW-w64]]
 +
* (historical) [[RBuild]]
  
 
[[Category:Building]]
 
[[Category:Building]]
 
[[Category:Tutorial]]
 
[[Category:Tutorial]]

Latest revision as of 00:21, 1 April 2024

This page describes the steps necessary to build ReactOS.
ReactOS supports building on different operating systems and with different compilers. Currently GCC, MSVC and LLVM/Clang can be used.

The build process differs depending your operating system and the compiler of choice.
Each build step in the tutorial is separated by OS/compiler when necessary. Choose ones which fit your configuration.

Which compiler to use

  • GCC is currently a recommended option as the most simple to use.
  • MSVC compiler can be used for better debugging capabilities (only MSVC builds support windbg debugger).
  • Clang support is currently experimental and not advised unless you know what are you doing.

Prerequisites

Visual Studio installation remarks
  • Download the Visual studio 2017 community edition (or later).
When selecting the options, be sure to at least include Desktop development with C++.

Desktop development

  • Ensure you have started visual studio at least once, and you are able to create a working c++ project.
To validate this, choose Create a new project, choose Console App, and use all default options.
  • While installing RosBE, you may choose the option Add BIN folder to PATH variable (may be added later manually).

RosBE BIN folder.png

Imbox notice.png

Notice: It is recommended to disable antivirus software before proceeding (or adding a build folder to exceptions), because some AVs may detect ReactOS' system files (in particular, crtdll.dll or csrss.exe) as being infected.

TL;DR

<inside RosBE command prompt>
git clone https://github.com/reactos/reactos
cd reactos
configure.cmd
cd output-MinGW-i386
ninja bootcd livecd

Building instructions

1. Prepare a command prompt

Windows/GCC or ReactOS/GCC

  • Just use the RosBE command prompt (from the Start menu)

*nix/GCC

  • Invoke RosBE.sh script

*nix/Clang

  • Invoke RosBE.sh script, ensure clang is available in $PATH

Windows/MSVC

  • Open a Visual Studio command prompt for a desired target architecture (x86 or amd64).
  • Add RosBE's bin folder to PATH (if you have not done that during the RosBE installation), like this:
set PATH=C:\RosBE\Bin;%PATH%
  • Set the M4 and BISON_PKGDATADIR environment variables:
set M4=C:\RosBE\Bin\m4.exe
set BISON_PKGDATADIR=C:\RosBE\share\bison

NOTE: C:\RosBE is an example path of RosBE. You may choose a different one.

Windows/Clang

  • Same as MSVC, but also ensure that clang-cl.exe and other LLVM tools are added to PATH

2. Obtain the source code

  git clone https://github.com/reactos/reactos.git

3. Do the "configure" step

Before building 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. Please make sure you are running it from within a prepared build environment (step 1).

Windows or ReactOS

configure.cmd [CMake generator] [Additional CMake options]

CMake generator is one of the following:

  • Ninja (default) use Ninja as a CMake backend
  • VSSolution use MSBuild/sln file as a CMake backend (for working with the source code inside Visual Studio)

*nix

./configure.sh [Additional CMake options]

Additional options

Additional CMake command line options may be passed in this format: -DOPTION=VALUE. Available options:

  • ARCH target architecture. Either "i386" (default), "amd64" or "arm".
  • SARCH architecture flavor. For i386 "pc" (default), "pc98" or "xbox" values are supported
  • ENABLE_ROSTESTS include tests in the build. Either "0" (default) or "1".
  • ENABLE_ROSAPPS include extra utilities in the build. Either "0" (default) or "1".
  • PCH enable precompiled headers to increase the build speed. NOTE: may consume 7-15GB more space. Defaults to "1" for MSVC and "0" for GCC.
  • USE_CLANG_CL use clang-cl compiler instead of cl (only on Windows). Either "0" (default) or "1".
  • NO_REACTOS_BUILDNO do not include commit hash and date in the image. This allows to avoid recompiling the image when date changes. Either "0" (default) or "1".

So to configure an MSVC build with ninja and rosapps and rostests, you would use: 

configure.cmd -DENABLE_ROSTESTS=1 -DENABLE_ROSAPPS=1

4. Start the build

This step depends on what has been chosen as a CMake generator.

Ninja

From the build folder (e.g. reactos\output-MinGW-i386) enter the following command: 

ninja [targets]

Available targets are:

  • bootcd creates an installation ISO to install ReactOS on a VM or PC.
  • livecd creates a live CD ISO to try ReactOS without installing.
  • all builds all binaries of ReactOS. ISO files are not created though.
  • clean cleans all files of your working copy except the generated ISO files (if any).
  • Any other binary file ReactOS consists of, for example kernel32 or ntoskrnl

VSSolution (Visual Studio)

Icon speedy deletion.png Warning: Visual Studio (VSSolution) build cannot currently produce a bootable ISOs so use it for working with individual user-mode apps (like notepad, rapps or paint). For building bootcd or livecd configuration, please use Ninja option.


For this example we are going to see how to build rapps from Visual Studio 2019.

  • If configure step went well, this message should appear:
Configure script complete! You can now use msbuild or open REACTOS.sln.
  • There should now be a REACTOS.sln in your build folder (Which contains ALL projects!)
  • Since rapps has the cmake [project(rapps)] macro, there will also be a smaller solution just for rapps at base\applications\rapps\rapps.sln
  • Open this solution, and expand base\rapplications\rapps
  • Right click rapps, choose Set as Startup Project

Set as Startup Project.png

  • Press Debug->Start Debugging in the menu, or the hotkey that is displayed behind it (usually F5)

See also

Retrieved from "https://reactos.org/wiki/index.php?title=Building_ReactOS&oldid=55522"