$Id$ Casper Hornstrup Emanuele Aliberti 2005

To generate GNU make makefiles and building ReactOS, do the following: Go to the top-level reactos directory; Run the command:mingw32-make This will start building ReactOS. To build a bootable CD, run the following command:mingw32-make bootcdThis will create ReactOS.iso in the top-level reactos directory.

XML files are used throughout the ReactOS source tree to drive the build system.

The top-level XML build file (ReactOS.xml) is processed by rbuild. The following is an example of how it could look like:<?xml version="1.0"?> <!DOCTYPE project SYSTEM "tools/rbuild/project.dtd"> <project name="ReactOS" makefile="Makefile.auto" xmlns:xi="http://www.w3.org/2001/XInclude"> <xi:include href="config.xml"> <xi:fallback> <xi:include href="config.template.xml" /> </xi:fallback> </xi:include> <define name="_M_IX86" /> <if property="DBG" value="1"> <define name="DBG" value="1" /> <property name="DBG_OR_KDBG" value="true" /> </if> <include base="ReactOS">include</include> <directory name="boot"> <xi:include href="boot/boot.xml" /> </directory> <module name="bootcd" type="iso"> </module> </project>

XML files used by rbuild are modular and use XInclude to include other chunks of XML in the top-level ReactOS.xml file. The namespace used by XInclude is xi.

It is possible to split an XML build file over several files. The include element in the xi namespace is used to accomplish this.

<xi:include href="config.xml"> <xi:fallback> <xi:include href="config.template.xml" /> </xi:fallback> </xi:include>

href Name of XML build file to include. The filename is relative to the location of the current XML build file.

None.

xi:fallback.

This element is used to provide the name of an alternate file that is to be included if the first include file did not exists.

<xi:fallback> <xi:include href="config.template.xml" /> </xi:fallback>

None.

None.

xi:include.

xi:include.

A bootstrap element specifies that the generated file should be put on the bootable CD as a bootstrap file.

<bootstrap base="reactos" nameoncd="halmp.dll" />

base Put file in this directory on the bootable CD. This attribute is optional. nameoncd Name of file on the bootable CD. This attribute is optional.

None.

None.

A cdfile element specifies the name of a file that is to be put on the bootable CD.

<cdfile base="reactos" nameoncd="ReadMe.txt">ReadMe.txt</cdfile>

base Put file in this directory on the bootable CD. This attribute is optional. nameoncd Name of file on the bootable CD. This attribute is optional.

Name of file.

None.

A component element specifies that imports from a library are to be stubbed so tests can be run without actually calling the functions in the library. This element can only be used for modules of type test.

<component name="ntdll.dll"> ... </component>

name Name of library.

None.

symbol.

A define element specifies the name and (optionally) value of a define for the C/C++ compiler and resource compiler.

<define name="WINVER">0x501</define>

name Name of define.

Value of define. The value is optional.

None.

A dependency element specifies the name of a module (usually of type buildtool) that is to be processed before the current module.

<dependency>OtherModule</dependency>

None.

Name of module.

None.

A directory element specifies the name of a subdirectory.

<directory name="MyDirectory"> ... </directory>

name Name of directory.

None.

cdfile, directory, file, if, pch, property.

A file element specifies the name of a file that is to be processed.

<file>MyFile.c</file>

None.

Name of file.

None.

An if element allows for conditional processing of other elements.

<if property="DBG" value="1"> ... </if>

property Name of the property that is to be evaluated. value Value to compare to the value of the property. If the property has the specified value, then the subelements are processed.

None.

compilerflag, define, directory, file, if, include, property.

An importlibrary element specifies that an import library should be generated which other modules can use to link with the current module.

<importlibrary definition="MyModule.def" />

definition Filename of definition file (.def) used to generate the import library. The filename is relative to the current module.

None.

None.

An include element specifies an include directory for the C/C++ compiler and resource compiler.

<include base="MyLibraryModule">include</include>

base Module or project which the value of this element is relative to. This attribute is optional. If left out, the include directory is relative to the position of the top-level XML build file.

Relative include directory.

None.

An input element specifies a group of filenames that is to be passed as parameters to a build tool. Input filename parameters are located after output filename parameters on the command line.

<input> ... </input>

None.

None.

invoke.

inputfile.

An inputfile element specifies a filename that is to be passed as a parameter to a build tool.

<inputfile>ntoskrnl.mc</inputfile>

switches Switches that is passed as parameters just before the filename. This attribute is optional.

Name of file that is to be passed as a parameter to the build tool.

input.

None.

An installfile element specifies the name of a file that is to be installed when using 'make install'.

<installfile base="reactos" newname="ReadMe.txt">ReadMe.txt</installfile>

base Put file in this directory within the install directory. This attribute is optional. newname Name of file within the install directory. This attribute is optional.

Name of file.

None.

An invoke element specifies the name of a module which is to be executed before the current module is processed.

<invoke module="wmc"> <input> <inputfile>ntoskrnl.mc</inputfile> </input> <output> <outputfile switches="-H">../include/reactos/bugcodes.h</outputfile> <outputfile switches="-o">bugcodes.rc</outputfile> </output> </invoke>

module Name of the module to execute.

None.

input, output.

A library element specifies the name of another module which is to be linked with the current module.

<library>MyLibraryModule</library>

None.section

module.

None.

A likerflag element specifies flags to be passed to the linker tool.

<linkerflag>-lgcc</linkerflag>

None.

The switches to pass to the linker.

None.

There can be zero or more modules per XML build file.

<module if="${MP}" ifnot="${MP}" name="msvcrt" type="win32dll" extension=".dll" entrypoint="_DllMain@12" baseaddress="0x70000000" mangledsymbols="true" installbase="system32" installname="msvcrt.dll" usewrc="false" warnings="true" aliasof="module1"> ... </module>

if If the value is 1, then the module is enabled, otherwise it is disabled. A disabled module is not processed. ifnot If the value is 1, then the module is disabled, otherwise it is enabled. A disabled module is not processed. name Name of the module. Also the base name of the generated file if such file is generated for the particular module type. type Type of module. See below for an explanation of module types. The module type determines the actions that is to be carried out to process the module. The defined module types are seen below: Value Output name suffix Entrypoint Baseaddress Mangledsymbols Description buildtool .exe (Windows) none (Linux) ---Builds a tool that can be run (invoked) when building ReactOS. staticlibrary .a - - - Builds a static library containing object files that can be linked together with other modules. objectlibrary .o - - - Builds object files that can be linked together with other modules. kernel .exe _NtProcessStartup - - Builds ntoskrnl.exe. kernelmodedll .dll _DriverEntry@8 - - Builds a kernel-mode DLL. kernelmodedriver .sys _DriverEntry@8 - - Builds a kernel-mode driver. nativedll .dll _DllMainCRTStartup@12 - - Builds a native DLL. win32dll .dll _DllMain@12 - - Builds a Win32 DLL. win32cui .exe _mainCRTStartup - - Builds a Win32 console executable. win32gui .exe _WinMainCRTStartup - - Builds a Win32 GUI executable. bootloader - - - - Builds a bootloader. bootsector - - - - Builds one or more bootsector binaries. iso - - - -. Builds a bootable CD. test .exe _mainCRTStartup - - Builds a testsuite. rpcserver .o - - - Generates and builds server code for an RPC interface. rpcclient .o - - - Generates and builds client code for an RPC interface. alias - - - - Module is an alias for another module. This module type is the only module type for which the aliasof attribute is applicable. Only the module install functionality is aliased. extension Extension of the generated file if such file is generated for the particular module type. entrypoint Entrypoint symbol of the generated file if such file is generated for the particular module type. baseaddress Base address of the generated file if such file is generated for the particular module type. mangledsymbols Controls wether or not to pass --kill-at to dlltool. If this attribute has the value false then --kill-at is passed to dlltool. If the value is true, then --kill-at is not passed to dlltool. If the generated file exports C++ classes then this need to be true. installbase Base directory of the generated file in the installation directory. This attribute is optional. installname Name of generated file in the installation directory. This attribute is optional, but if not specified, the generated file is not copied to the installation directory. usewrc Use WRC to compile resources if true. If false, windres is used. This attribute is optional. If not specified, WRC will be used. warnings Error out if false and at least one warning is emitted during building of this module. This attribute is optional. If not specified, it is assumed to be false. aliasof Name of module that is aliased.

None.

project.

bootstrap, component, define, dependency, directory, file, if, importlibrary, include, invoke, library, property.

An output element specifies a group of filenames that is to be passed as parameters to a build tool. Output filename parameters are located before input filename parameters on the command line.

<output> ... </output>

None.

None.

invoke

outputfile.

An outputfile element specifies a filename that is to be passed as a parameter to a build tool.

<outputfile switches="-H">../include/reactos/bugcodes.h</outputfile>

switches Switches that are passed as parameters just before the filename. This attribute is optional.

Name of file that is to be passed as a parameter to the build tool.

output.

None.

A pch element specifies a GCC precompiled header file.

<pch>ntdll.h</pch>

None.

Name of the include file to be precompiled.

None.

There can be one project per top-level XML build file. A project can only be defined in a top-level XML build file.

<project name="ReactOS" makefile="Makefile.auto" xmlns:xi="http://www.w3.org/2001/XInclude"> ... </project>

name Name of the project. makefile Filename of the GNU makefile that is to be created.

None.

None. This is the top-level (root) element of ReactOS.xml file.

define, directory, if, include, module, property.

A property element specifies the name and value of a property that can be used for conditional processing of the XML build file.

<property name="mypropertyname" value="mypropertyvalue" />

name Name of property. value Value of property.

None.

None.

A symbol element specifies an imported function from a library that is to be stubbed so tests can be run without actually calling the function in the library.

<symbol newname="RtlAllocateHeap">HeapAlloc@12</symbol>

newname New name of symbol. This attribute is optional.

Name of symbol.

None.

W3C Recommendation François Yergeau Tim Bray Jean Paoli C. M. Sperberg-McQueen Eve Maler 4th February 2004 W3C Recommendation Jonathan Marsh Microsoft jmarsh@microsoft.com David Orchard BEA Systems dorchard@bea.com 20 December 2004