Difference between revisions of "Building ReactOS"

From ReactOS Wiki
Jump to: navigation, search
(Building ReactOS)
(27 intermediate revisions by 15 users not shown)
Line 1: Line 1:
 +
<!-- '''NOTE: This page is deprecated and is purely here for archival purposes. For instructions on building ReactOS, please see the [http://www.reactos.org/development/build-environment build environment] page of the development guide.''' -->
 
This page describes the steps necessary to build ReactOS.
 
This page describes the steps necessary to build ReactOS.
  
 
== Getting all you need ==
 
== Getting all you need ==
 +
=== Setting up a Build Environment ===
 +
For building ReactOS you also need the official [[ReactOS Build Environment]]. Please download and install it from that page.
 +
 +
Make sure that no interfering build environment (such as MSYS) is in your PATH environment variable when building.
 +
 +
<!-- {{Notice|Due to a current bug, the build environment can not use a build folder that contains spaces in its path name.<br />
 +
Under Windows XP and 2003 you  must change the default location of "C:\Documents and Settings\[username]\reactos\".}} -->
 +
=== Optional: Set Up Visual Studio ===
 +
If you want to use Visual Studio to compile ReactOS, you need to get one of the supported version, which is VS2010 and later. You can download the free Community Edition of Visual Studio 2015. To compile with VS, open the appropriate VS command prompt and follow the same instructions as for building with the GCC based ReactOS build environment. Note that you still need the ReactOS build environment, which contains CMake and some additional tools, or you can install the latest version of CMake yourself, but that is not recommended. If you experience problems with the configure stage, e.g. the compiler is reported to not be working, please check if you have installed any additional Windows SDKs or WDK and try again after removing them.
  
 
=== Getting a Working Copy ===
 
=== Getting a Working Copy ===
 
 
The first step in building ReactOS is getting a copy of the source code.
 
The first step in building ReactOS is getting a copy of the source code.
  
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.  
+
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.
To get a working copy of ReactOS, please read the [[Subversion]] page.
+
To get a working copy of ReactOS, please read the [[ReactOS_Git_For_Dummies|ReactOS Git For Dummies]] page.
 
 
If you do not use a separate SVN client, the command "ssvn create" from within the build environment will download it.
 
 
 
=== Setting up a Build Environment ===
 
 
 
For building ReactOS you also need the official [[ReactOS Build Environment]]. Please download and install it from that page.
 
  
Make sure that no interfering build environment (such as MSYS) is in your PATH environment variable when building.
+
You need to have [https://git-scm.com/ Git] installed on your system. The command
 +
git clone https://github.com/reactos/reactos.git
 +
from within the command prompt will download it.
  
{{Notice|Due to a current bug, the build environment can not use a build folder that contains spaces in its path name.<br />
+
If you attempt to build '''ReactOS on ReactOS''', note that due to [https://jira.reactos.org/browse/CORE-12931 CORE-12931], you won't be able to use a git clone on your ReactOS install. You should instead download a zip from GitHub that contains the source code. Then, extract it on your system.
Under Windows XP and 2003 you  must change the default location of "C:\Documents and Settings\[username]\reactos\".}}
 
  
 
== Prerequisites ==
 
== Prerequisites ==
 
+
{{Notice|It is recommended to temporarily disable your antivirus before proceeding, because some of them detect some of ReactOS' system files (in particular, crtdll.dll) as being infected.}}
You may want to temporarily disable your antivirus before proceeding.  
 
  
 
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. Please make sure you are running it from within ReactOS BE:
 
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. Please make sure you are running it from within ReactOS BE:
Line 31: Line 34:
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
 
  configure.sh
 
  configure.sh
  cd output-MinGW-i386
+
  cd output-MinGW-i386/reactos
 
</syntaxhighlight>
 
</syntaxhighlight>
=== Windows ===
+
 
 +
=== Windows or ReactOS ===
 
Run:
 
Run:
 
<syntaxhighlight lang="dos">
 
<syntaxhighlight lang="dos">
 
  configure.cmd
 
  configure.cmd
 +
cd output-MinGW-i386
 
</syntaxhighlight>
 
</syntaxhighlight>
 
After executing, folder <tt>output-MinGW-i386</tt> will be created in root of ReactOS tree. You will be redirected to it.
 
After executing, folder <tt>output-MinGW-i386</tt> will be created in root of ReactOS tree. You will be redirected to it.
 +
If you want to build in a different folder, cd to that folder first and then execute
 +
<code>
 +
<path_to_source>\configure.cmd
 +
</code>
  
=== Building Tools ===
+
configure.cmd currently supports the following options:
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.
+
* <code>/?</code> displays help
 +
* <code>Codeblocks</code> creates a CodeBlocks solution
 +
* <code>Eclipse</code> creates an Eclipse solution
 +
* <code>Makefiles</code> creates (n)make files
 +
* <code>clang</code> Uses clang instead of gcc
 +
* <code>VSSolution</code> Creates a Visual Studio solution
 +
* <code>RTC</code> enables extra runtime checks
  
From your output directory, go to <tt>host-tools</tt>. Follow specific instruction for your compiler.
+
You can additionally specify any number of cmake command line options, like "-DSYMBOL=VALUE".
<syntaxhighlight lang="dos">
 
cd host-tools
 
make
 
</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.
 
  
 +
=== Building ReactOS on Windows or ReactOS* ===
 +
From the build folder (e.g. reactos\output-MinGW-i386) enter the following command:
 +
<code>
 +
ninja COMMANDS
 +
</code>
  
=== Building ReactOS ===
+
Replace "COMMANDS" with the desired build commands, such as <code>bootcd</code> or <code>livecd</code>, listed below:
  
Change to the "reactos" folder located inside output-MinGW-i386 (i.e. reactos\output-MinGW-i386\reactos):
+
<small>* Perhaps, some functions of RosBE may not work on ReactOS. If so, please have a look on our [http://jira.reactos.org/ Jira] page whether this problem is already reported or not.</small>
<syntaxhighlight lang="dos">
 
cd ..\reactos
 
make COMMANDS
 
</syntaxhighlight>
 
Combining the above steps together:
 
<syntaxhighlight lang="dos">
 
configure.cmd
 
cd output-MinGW-i386
 
cd host-tools
 
make
 
cd ..\reactos
 
make COMMANDS
 
</syntaxhighlight>
 
Replace "COMMANDS" with the desired build commands, such as "bootcd" or "livecd", listed below:
 
  
 
=== Building ReactOS on Unix/Linux ===
 
=== Building ReactOS on Unix/Linux ===
 
+
<code>
Change to the "reactos" folder located inside output-MinGW-i386 (i.e. reactos/output-MinGW-i386/reactos):
 
<syntaxhighlight lang="bash">
 
cd ../../output-MinGW-i386/reactos
 
 
  ninja COMMANDS
 
  ninja COMMANDS
</syntaxhighlight>
+
</code>
 
Combining the above steps together:
 
Combining the above steps together:
<syntaxhighlight lang="bash">
+
Replace "COMMANDS" with the desired build commands, such as <code>bootcd</code> or <code>livecd</code>, listed below:
configure.sh
 
cd output-MinGW-i386/host-tools
 
ninja
 
cd ../reactos
 
ninja COMMANDS
 
</syntaxhighlight>
 
Replace "COMMANDS" with the desired build commands, such as "bootcd" or "livecd", listed below:
 
  
 
== Commands ==
 
== Commands ==
Line 92: Line 83:
 
=== Invoking a build ===
 
=== Invoking a build ===
  
'''make'''
+
<code>'''ninja'''</code> or <code>'''ninja all'''</code>
This command builds all binaries of ReactOS. They will be placed in the directory specified by the ROS_OUTPUT environment variable. (default: ''output-i386'')
+
 
 +
This command builds all binaries of ReactOS. They will be placed in the created output directory created by the configure command. (default: ''output-MinGW-i386/reactos'')
 
All source files, which did not change since the last build, will not be built again.
 
All source files, which did not change since the last build, will not be built again.
  
'''make bootcd'''
+
<code>'''ninja bootcd'''</code>
This command works like ''make'', but also generates a bootable ReactOS ISO file (''ReactOS.iso'') in the base of the working copy.
+
 
 +
This command works like ''make'', but also generates a bootable ReactOS ISO file (''bootcd.iso'') placed into the output directory.
 
It is wise to tag your Boot-CDs with the revision they were built from if you need to keep many ReactOS ISOs.
 
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'''
+
<code>'''ninja livecd'''</code>
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
 
  
'''make install'''
+
This command generates ''livecd.iso'' in the output directory. This is the ReactOS Live-CD that runs completely from the CD-ROM.
This command copies all the ReactOS binaries to their proper installation directory as specified in the ROS_INSTALL environment variable. (default: ''reactos'')
 
  
'''makex'''
+
<code>'''ninja hybridcd'''</code>
Used instead of make will utilize all physical cores on your machine.
 
  
 +
This command generates ''hybridcd.iso'' in the output directotry. This is a hybrid cd of ReactOS
 +
 +
<!--
 
=== Other ===
 
=== Other ===
  
 
'''clean'''
 
'''clean'''
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.
+
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. -->
 
+
<!-- to be continued -->
'''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 ==
 
== Adding modules to the build process ==
Line 146: Line 114:
 
The page [[Building Modules]] describes, which modules exist and how to add them to the build process.
 
The page [[Building Modules]] describes, which modules exist and how to add them to the build process.
  
==See also ==
+
== See also ==
 +
* '''[http://www.reactos.org/development/build-environment Build Environment] – another tutorial how to build ReactOS '''
 
* [[Building with MSVC]]
 
* [[Building with MSVC]]
 
* [[Building MINGW-w64]]
 
* [[Building MINGW-w64]]
 
* [http://www.reactos.org/forum/viewtopic.php?f=22&t=11000 Building with Ninja] latest build method, RosBE v2.1
 
* [http://www.reactos.org/forum/viewtopic.php?f=22&t=11000 Building with Ninja] latest build method, RosBE v2.1
* [http://www.reactos.org/development/build-environment Build Environment], ninja commands
 
 
  
 
[[Category:Building]]
 
[[Category:Building]]
 
[[Category:Tutorial]]
 
[[Category:Tutorial]]

Revision as of 10:37, 3 June 2018

This page describes the steps necessary to build ReactOS.

Getting all you need

Setting up a Build Environment

For building ReactOS you also need the official ReactOS Build Environment. Please download and install it from that page.

Make sure that no interfering build environment (such as MSYS) is in your PATH environment variable when building.

Optional: Set Up Visual Studio

If you want to use Visual Studio to compile ReactOS, you need to get one of the supported version, which is VS2010 and later. You can download the free Community Edition of Visual Studio 2015. To compile with VS, open the appropriate VS command prompt and follow the same instructions as for building with the GCC based ReactOS build environment. Note that you still need the ReactOS build environment, which contains CMake and some additional tools, or you can install the latest version of CMake yourself, but that is not recommended. If you experience problems with the configure stage, e.g. the compiler is reported to not be working, please check if you have installed any additional Windows SDKs or WDK and try again after removing them.

Getting a Working Copy

The first step in building ReactOS is getting a copy of the source code.

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. To get a working copy of ReactOS, please read the ReactOS Git For Dummies page.

You need to have Git installed on your system. The command

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

from within the command prompt will download it.

If you attempt to build ReactOS on ReactOS, note that due to CORE-12931, you won't be able to use a git clone on your ReactOS install. You should instead download a zip from GitHub that contains the source code. Then, extract it on your system.

Prerequisites

Imbox notice.png Notice: It is recommended to temporarily disable your antivirus before proceeding, because some of them detect some of ReactOS' system files (in particular, crtdll.dll) as being infected.

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. Please make sure you are running it from within ReactOS BE:

Linux/Unix

Run:

 configure.sh
 cd output-MinGW-i386/reactos

Windows or ReactOS

Run:

 configure.cmd
 cd output-MinGW-i386

After executing, folder output-MinGW-i386 will be created in root of ReactOS tree. You will be redirected to it. If you want to build in a different folder, cd to that folder first and then execute

<path_to_source>\configure.cmd

configure.cmd currently supports the following options:

  • /? displays help
  • Codeblocks creates a CodeBlocks solution
  • Eclipse creates an Eclipse solution
  • Makefiles creates (n)make files
  • clang Uses clang instead of gcc
  • VSSolution Creates a Visual Studio solution
  • RTC enables extra runtime checks

You can additionally specify any number of cmake command line options, like "-DSYMBOL=VALUE".

Building ReactOS on Windows or ReactOS*

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

ninja COMMANDS

Replace "COMMANDS" with the desired build commands, such as bootcd or livecd, listed below:

* Perhaps, some functions of RosBE may not work on ReactOS. If so, please have a look on our Jira page whether this problem is already reported or not.

Building ReactOS on Unix/Linux

ninja COMMANDS

Combining the above steps together: Replace "COMMANDS" with the desired build commands, such as bootcd or livecd, listed below:

Commands

After you have started a Build Environment Command Prompt, there are certain commands available.

Invoking a build

ninja or ninja all

This command builds all binaries of ReactOS. They will be placed in the created output directory created by the configure command. (default: output-MinGW-i386/reactos) All source files, which did not change since the last build, will not be built again.

ninja bootcd

This command works like make, but also generates a bootable ReactOS ISO file (bootcd.iso) placed into the output directory. It is wise to tag your Boot-CDs with the revision they were built from if you need to keep many ReactOS ISOs.

ninja livecd

This command generates livecd.iso in the output directory. This is the ReactOS Live-CD that runs completely from the CD-ROM.

ninja hybridcd

This command generates hybridcd.iso in the output directotry. This is a hybrid cd of ReactOS


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