Difference between revisions of "Build Environment"

From ReactOS Wiki
Jump to: navigation, search
(Included Utilities)
m (Protected "Build Environment": High traffic page: The de-facto official RosBE download page ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
 
(37 intermediate revisions by 20 users not shown)
Line 1: Line 1:
== Introduction ==
+
To build ReactOS you will need a suitable build environment. Currently ReactOS Source Code is able to be compiled using both open source (gcc, mingw, …), and Microsoft's compiler tools, with the official ReactOS Build Environment (RosBE) being recommended. If you want to report problems, please first make sure that you use the latest version of the ReactOS Build Environment.
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 by us.
 
 
 
So if you want to report problems, please first make sure that you use the latest version of the ReactOS Build Environment.
 
  
 
== Download the Build Environment ==
 
== Download the Build Environment ==
There are two ReactOS Build Environments available, a version for Windows NT-compatible Operating Systems (Windows 2000, XP, Server 2003, ...) and a version for Unix-compatible operating systems (Linux, FreeBSD, ...).
 
  
 +
There are two ReactOS Build Environments available, a version for Windows NT-compatible operating systems (Windows XP, Windows Vista, 7, etc.) and a version for Unix-compatible operating systems (Linux, FreeBSD, etc.).
  
[[Image:RosBE.png|64px|left]]
+
=== Windows ===
<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]</span><br />
+
----
''Version {{RosBE-Windows-Version}}''
+
<span style="font-size: 12pt; font-weight: bold; ">[[File:RosBE.png|32px]]
 +
[http://sourceforge.net/projects/reactos/files/RosBE-Windows/i386/{{RosBE-Windows-Version}}/RosBE-{{RosBE-Windows-Version}}.exe/download ReactOS Build Environment for Windows NT-compatible OS ''Version {{RosBE-Windows-Version}}'']
 +
</span>
 +
* For older versions, please have a look at our [http://sourceforge.net/projects/reactos/files/RosBE-Windows/i386/ ReactOS SourceForge project page]
 +
----
  
[http://downloads.sourceforge.net/reactos/RosBE64-{{RosBE64-Windows-Version}}.exe 64 bit Compiler Addon - Version {{RosBE64-Windows-Version}}]
+
=== Unix and Linux ===
<p style="margin-bottom: 10px;">&nbsp;</p>
+
----
 +
<span style="font-size: 12pt; font-weight: bold;">[[File:RosBE.png|32px]]
 +
[http://downloads.sourceforge.net/reactos/RosBE-Unix-{{RosBE-Unix-Version}}.tar.bz2 ReactOS Build Environment for Unix-compatible Operating Systems ''Version {{RosBE-Unix-Version}}'']</span>
 +
* For older versions, please have a look at our [http://sourceforge.net/projects/reactos/files/RosBE-Unix/ ReactOS SourceForge project page]
 +
* '''System Requirements:''' Please look at the <tt>README</tt> file for detailed information about the needed packages and other requirements.
 +
----
 +
== Next Steps ==
  
[[Image:RosBE.png|64px|left]]
+
After setting up your build environment, see [[Building ReactOS]] for downloading source and further information.
<span style="font-size: 12pt; font-weight: bold;">[http://downloads.sourceforge.net/reactos/RosBE-Unix-{{RosBE-Unix-Version}}.tar.bz2 ReactOS Build Environment for Unix-compatible Operating Systems]</span><br />
 
''Version {{RosBE-Unix-Version}}''
 
  
<p style="clear: left;"></p>
+
== Included Utilities ==
  
 +
All these Information can be found in RosBE, too by typing <code>help</code>.
  
For older versions, please visit the [http://sourceforge.net/project/showfiles.php?group_id=6553 ReactOS SourceForge project page].
+
=== <code>BASEDIR</code> ===
  
== System Requirements ==
+
Small command which immediately sets you back to the ReactOS Source Base Directory.
=== RosBE-Unix ===
 
Please look up the README file for detailed information about the needed packages and other requirements.
 
  
== Next Steps ==
+
=== <code>CHARCH</code> ===
Additionally, a [[Subversion]] client is needed to obtain the current source from the ReactOS Subversion repository.
 
Read that page for more information.
 
For newer build Environments on Windows (0.3.7+), 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 futher information.
 
 
You may want to use an IDE, so refer to [[using an IDE|this page]].
 
 
== Included Utilities ==
 
 
=== 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.
 
Change the Architecture to build ReactOS for, for the current RosBE session.
 
Possible Architectures are right now:
 
Possible Architectures are right now:
Line 50: Line 39:
 
* '''amd64'''
 
* '''amd64'''
  
=== CHDEFDIR ===
+
=== <code>CHDEFDIR</code> ===
 +
 
 
Change the ReactOS source directory for the current RosBE session.
 
Change the ReactOS source directory for the current RosBE session.
  
 
* '''previous''': Switch to the previous ReactOS source directory.
 
* '''previous''': Switch to the previous ReactOS source directory.
  
=== CHDEFGCC ===
+
=== <code>CHDEFGCC</code> ===
Usage: chdefgcc [PATH] [TYPE]
+
 
 +
Usage: <code>chdefgcc [PATH] [TYPE]</code>
 
Change the MinGW/GCC directory for the current RosBE session.
 
Change the MinGW/GCC directory for the current RosBE session.
  
Line 62: Line 53:
 
* '''Type''': Set it to "target" or "host"
 
* '''Type''': Set it to "target" or "host"
  
=== RADDR2LINE ===
+
=== <code>RADDR2LINE</code> ===
Usage: raddr2line [FILE] [ADDRESS]
+
<!--the template does not work her so well -->
 +
''Main article: [[Debugging#Translating Addresses|Debugging – Translating Addresses]]''
 +
 
 +
Usage: <code>raddr2line [FILE] [ADDRESS]</code>
 
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.
 
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.
  
Line 69: Line 63:
 
* '''ADDRESS''': The address to be translated.
 
* '''ADDRESS''': The address to be translated.
  
=== SCUT ===
+
=== <code>SCUT</code> ===
 +
 
 
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.
 
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:
 
You can pass the following parameters to scut:
Line 81: Line 76:
 
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.
 
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 ===
+
=== <code>SSVN</code> ===
 +
 
 +
This command is '''not used anymore''', see [[Building ReactOS#Getting a Working Copy]].
 +
 
 +
Windows ONLY.
 
Creates, updates or cleans up your ReactOS source tree or shows the revision number of the local and online trees.
 
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.
 
* '''update''': Updates to HEAD revision or to a specific one when the second parameter specifies one.
 
* '''create''': Creates a new ReactOS source tree.
 
* '''create''': Creates a new ReactOS source tree.
* '''rosapps''': Creates a new ReactOS RosApps source tree.
+
* '''rosapps''': Creates/Updates a ReactOS RosApps source tree.
* '''rostests''': Creates a new ReactOS RosTests source tree.
+
* '''rostests''': Creates/Updates a ReactOS RosTests source tree.
 
* '''cleanup''': Cleans up and fixes errors in the source tree.
 
* '''cleanup''': Cleans up and fixes errors in the source tree.
 
* '''status''': Show the current local and online revision numbers.
 
* '''status''': Show the current local and online revision numbers.
  
=== UPDATE ===
+
=== <code>UPDATE</code> ===
 +
 
 +
Windows ONLY.
 
Updates all files of RosBE to the most recent files.
 
Updates all files of RosBE to the most recent files.
  
Line 101: Line 102:
  
 
== Questions or Problems? ==
 
== Questions or Problems? ==
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.
+
 
 +
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] or [irc://irc.freenode.net/reactos #reactos] IRC channels.
  
 
Otherwise you can also try to contact [[Daniel Reimer]] (Windows version), [[Colin Finck]] (Unix version) directly.
 
Otherwise you can also try to contact [[Daniel Reimer]] (Windows version), [[Colin Finck]] (Unix version) directly.
 
  
 
[[Category:Building]]
 
[[Category:Building]]
 +
[[Category:Tutorial]]

Latest revision as of 09:49, 15 August 2019

To build ReactOS you will need a suitable build environment. Currently ReactOS Source Code is able to be compiled using both open source (gcc, mingw, …), and Microsoft's compiler tools, with the official ReactOS Build Environment (RosBE) being recommended. If you want to report problems, please first make sure that you use the latest version of the ReactOS Build Environment.

Download the Build Environment

There are two ReactOS Build Environments available, a version for Windows NT-compatible operating systems (Windows XP, Windows Vista, 7, etc.) and a version for Unix-compatible operating systems (Linux, FreeBSD, etc.).

Windows


RosBE.png ReactOS Build Environment for Windows NT-compatible OS Version 2.1.6


Unix and Linux


RosBE.png ReactOS Build Environment for Unix-compatible Operating Systems Version 2.1.2

  • For older versions, please have a look at our ReactOS SourceForge project page
  • System Requirements: Please look at the README file for detailed information about the needed packages and other requirements.

Next Steps

After setting up your build environment, see Building ReactOS for downloading source and 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

Main article: Debugging – Translating Addresses

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

This command is not used anymore, see Building ReactOS#Getting a Working Copy.

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?

If you have problems or questions concerning the Build Environment, it's the best to ask in the #reactos-rosbe or #reactos IRC channels.

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