Difference between revisions of "Build Environment"

From ReactOS Wiki
Jump to: navigation, search
(Download the Build Environment)
m (Download)
 
(21 intermediate revisions by 11 users not shown)
Line 1: Line 1:
To build ReactOS you will need a suitable build environment. As the current ReactOS Source Code is only compatible with specific versions of the compiler tools, only the official ReactOS Build Environment (RosBE) is supported. If you want to report problems, please first make sure that you use the latest version of the ReactOS Build Environment.
+
Here you can download the ReactOS Build Environment (RosBE), the official build environment for compiling ReactOS from source code.
 +
It contains curated versions of all required build tools, such as Binutils, GCC, CMake, etc. RosBE makes sure that you can successfully build ReactOS without any hassle, and even if you hit problems, you won't be on your own.
  
== Download the Build Environment ==
+
If you like to build ReactOS using Microsoft Visual Studio instead of GCC, please install RosBE anyway.
 +
It contains some tools not available in Visual Studio (e.g. Bison and Flex) as well as some tool versions (e.g. CMake) where Visual Studio ships different ones.
  
There are two ReactOS Build Environments available, a version for Windows NT-compatible operating systems (Windows 2000, Windows XP, Windows Server 2003, etc.) and a version for Unix-compatible operating systems (Linux, FreeBSD, etc.).
+
If you want to report problems, please first make sure that you use the latest version of the ReactOS Build Environment.
  
 +
== Download ==
 +
<div style="display: flex;">
 +
<div style="padding-right: 10px;">[[File:RosBE.png|64px]]</div>
 +
<div>
 +
<p><span style="font-size: 16pt; font-weight:bold">[https://downloads.sourceforge.net/reactos/RosBE-{{RosBE-Windows-Version}}.exe RosBE-Windows {{RosBE-Windows-Version}}]</span><br>
 +
for building under [[File:Download-ReactOS.png|24px]] [[File:Download-Windows.png|24px]]</p>
 +
</div>
 +
</div>
  
[[Image:RosBE.png|64px|left]]
 
<span style="font-size: 12pt; font-weight: bold;">[http://downloads.sourceforge.net/reactos/RosBE-{{RosBE-Windows-Version}}.exe ReactOS Build Environment for Windows NT-compatible OS ''Version {{RosBE-Windows-Version}}'']</span><br />
 
  
[http://downloads.sourceforge.net/reactos/RosBE-ARM-{{RosBE-ARM-Windows-Version}}.exe ARM Addon - Version {{RosBE-ARM-Windows-Version}}]
+
<div style="display: flex;">
 +
<div style="padding-right: 10px;">[[File:RosBE.png|64px]]</div>
 +
<div>
 +
<p><span style="font-size: 16pt; font-weight:bold">[https://downloads.sourceforge.net/reactos/RosBE-Unix-{{RosBE-Unix-Version}}.tar.bz2 RosBE-Unix {{RosBE-Unix-Version}}]</span><br>
 +
for building under [[File:Download-Linux.png|24px]] [[File:Download-MacOS.png|24px]]</p>
  
<p style="margin-bottom: 10px;">&nbsp;</p>
+
[[File:Download-Ubuntu.png|24px]] Ubuntu 18.04 and 20.04 users can install a precompiled package from [https://launchpad.net/~reactos/+archive/ubuntu/rosbe-unix our Launchpad PPA] using:
 +
<pre>
 +
sudo add-apt-repository ppa:reactos/rosbe-unix
 +
sudo apt install rosbe-unix
 +
</pre>
 +
</div>
 +
</div>
  
[[Image:RosBE.png|64px|left]]
 
<span style="font-size: 12pt; font-weight: bold;">[http://downloads.sourceforge.net/reactos/RosBE-Unix-{{RosBE-Unix-Version}}-Amine.tar.bz2 ReactOS Build Environment for Unix-compatible Operating Systems ''Version {{RosBE-Unix-Version}}'']</span><br /><br />
 
  
<p style="clear: left;"></p>
+
Requirements:
 +
* Windows XP or later
 +
* Linux with GCC 6.x or later
 +
* macOS 10.11 or later (with Xcode Command Line Tools installed)
  
For older versions, please visit the [http://sourceforge.net/project/showfiles.php?group_id=6553 ReactOS SourceForge project page].
+
== Further Resources ==
 
+
* [[Building ReactOS]]
== System Requirements ==
+
* [[Build Environment/Included Utilities|Included Utilities]]
 
+
* [http://sourceforge.net/projects/reactos/files Older versions at our SourceForge project page]
=== RosBE-Unix ===
 
 
 
Please look at the <tt>README</tt> file for detailed information about the needed packages and other requirements.
 
 
 
== Next Steps ==
 
 
 
A [[Subversion]] client is needed to obtain the current source from the ReactOS Subversion repository (read that page for more information).
 
As of RosBe 0.3.7 on Windows, an SVN client is included:
 
Go into the empty ".\Source" directory and type "ssvn create" to download the ReactOS source.
 
 
 
After setting up your build environment, see [[Building ReactOS]] for further information.
 
 
 
== Included Utilities ==
 
 
 
All these Information can be found in RosBE, too by typing "help".
 
 
 
=== BASEDIR ===
 
 
 
Small command which immediately sets you back to the ReactOS Source Base Directory.
 
 
 
=== CHARCH ===
 
 
 
Change the Architecture to build ReactOS for, for the current RosBE session.
 
Possible Architectures are right now:
 
* '''i386'''
 
* '''amd64'''
 
 
 
=== CHDEFDIR ===
 
 
 
Change the ReactOS source directory for the current RosBE session.
 
 
 
* '''previous''': Switch to the previous ReactOS source directory.
 
 
 
=== CHDEFGCC ===
 
 
 
Usage: chdefgcc [PATH] [TYPE]
 
Change the MinGW/GCC directory for the current RosBE session.
 
 
 
* '''Path''': Path to set the Host or Target GCC to.
 
* '''Type''': Set it to "target" or "host"
 
 
 
=== RADDR2LINE ===
 
 
 
Usage: raddr2line [FILE] [ADDRESS]
 
Translates program addresses into file names and line numbers to assist developers with finding specific bugs in ReactOS. If either of the options is not given you will be prompted for it.
 
 
 
* '''FILE''': This can be either a fully specified path or just the file name [you can use a partial name ie. ntdll*] of the executable to be analyzed. When using just a file the current directory and all sub-directories are searched.
 
* '''ADDRESS''': The address to be translated.
 
 
 
=== SCUT ===
 
 
 
Simple utility for managing different directory locations. SCUT can be used to quickly change from one directory to another inside the BE prompt, making it easier to go to source in another directory. Included in both the Windows and Unix BEs.
 
You can pass the following parameters to scut:
 
 
 
* '''list''': Lists all shortcuts currently available.
 
* '''add''': Adds a shortcut to the list.
 
* '''edit''': Edits a shortcut on the list.
 
* '''rem''': Removes a shortcut from the list.
 
* '''def''': Switches to the default directory location, which is enabled on every start of RosBE.
 
 
 
If you want to use a directory shortcut, for example one with the name ''trunk'', just enter ''scut trunk'' and the program will switch to the directory you set for this shortcut.
 
 
 
=== SSVN ===
 
 
 
Windows ONLY.
 
Creates, updates or cleans up your ReactOS source tree or shows the revision number of the local and online trees.
 
 
 
* '''update''': Updates to HEAD revision or to a specific one when the second parameter specifies one.
 
* '''create''': Creates a new ReactOS source tree.
 
* '''rosapps''': Creates/Updates a ReactOS RosApps source tree.
 
* '''rostests''': Creates/Updates a ReactOS RosTests source tree.
 
* '''cleanup''': Cleans up and fixes errors in the source tree.
 
* '''status''': Show the current local and online revision numbers.
 
 
 
=== UPDATE ===
 
 
 
Windows ONLY.
 
Updates all files of RosBE to the most recent files.
 
 
 
* '''delete X''': Deletes Update Nr X.
 
* '''info X''': Shows info about Update Nr X.
 
* '''nr X''': Re/Installs Update Nr X.
 
* '''reset''': Removes the Updates Cache. Not recommended.
 
* '''status''': Shows the recent status of available, non installed updates.
 
  
 
== Questions or Problems? ==
 
== Questions or Problems? ==
 +
If you have problems or questions concerning the Build Environment, it's the best to ask in the [https://chat.reactos.org/reactos/channels/rosbe RosBE Mattermost channel].
  
If you have problems or questions concerning the Build Environment, it's the best to ask in the [irc://irc.freenode.net/reactos-rosbe #reactos-rosbe] IRC channel.
+
Otherwise, you can also contact [[Daniel Reimer]] (Windows version) or [[Colin Finck]] (Unix version) directly.
 
 
Otherwise you can also try to contact [[Daniel Reimer]] (Windows version), [[Colin Finck]] (Unix version) directly.
 
 
 
==See Also==
 
[http://www.reactos.org/forum/viewtopic.php?f=22&t=321 2005 Gentoo build environment tutorial] by  i386DX
 
 
 
  
 
[[Category:Building]]
 
[[Category:Building]]
 
[[Category:Tutorial]]
 
[[Category:Tutorial]]

Latest revision as of 17:22, 11 June 2020

Here you can download the ReactOS Build Environment (RosBE), the official build environment for compiling ReactOS from source code. It contains curated versions of all required build tools, such as Binutils, GCC, CMake, etc. RosBE makes sure that you can successfully build ReactOS without any hassle, and even if you hit problems, you won't be on your own.

If you like to build ReactOS using Microsoft Visual Studio instead of GCC, please install RosBE anyway. It contains some tools not available in Visual Studio (e.g. Bison and Flex) as well as some tool versions (e.g. CMake) where Visual Studio ships different ones.

If you want to report problems, please first make sure that you use the latest version of the ReactOS Build Environment.

Download

RosBE.png

RosBE-Windows 2.2.1
for building under Download-ReactOS.png Download-Windows.png


RosBE.png

RosBE-Unix 2.2.1
for building under Download-Linux.png Download-MacOS.png

Download-Ubuntu.png Ubuntu 18.04 and 20.04 users can install a precompiled package from our Launchpad PPA using:

sudo add-apt-repository ppa:reactos/rosbe-unix
sudo apt install rosbe-unix


Requirements:

  • Windows XP or later
  • Linux with GCC 6.x or later
  • macOS 10.11 or later (with Xcode Command Line Tools installed)

Further Resources

Questions or Problems?

If you have problems or questions concerning the Build Environment, it's the best to ask in the RosBE Mattermost channel.

Otherwise, you can also contact Daniel Reimer (Windows version) or Colin Finck (Unix version) directly.