reactos/tools/rbuild/doc/rbuild.txt

   1 ReactOS Build System Documentation
   2 ==================================
   3
   4 Building ReactOS
   5 ----------------
   6 To generate GNU make makefiles and building ReactOS do the following:
   7
   8         1) Go to the top-level reactos directory
   9         2) Run the command: mingw32-make
  10
  11 This will start building ReactOS.
  12
  13 To build a bootable CD run the following command:
  14
  15         mingw32-make bootcd
  16
  17 This will create ReactOS.iso in the top-level reactos directory.
  18
  19
  20 Top-level XML Build File
  21 ------------------------
  22 The top-level xml build file (ReactOS.xml) is processed by rbuild. The following is an example of how it could look like:
  23
  24 <?xml version="1.0"?>
  25 <!DOCTYPE project SYSTEM "tools/rbuild/project.dtd">
  26 <project name="ReactOS" makefile="Makefile.auto" xmlns:xi="http://www.w3.org/2001/XInclude">
  27         <xi:include href="config.xml">
  28                 <xi:fallback>
  29                         <xi:include href="config.template.xml" />
  30                 </xi:fallback>
  31         </xi:include>
  32
  33         <define name="_M_IX86" />
  34         <if property="DBG" value="1">
  35                 <define name="DBG" value="1" />
  36                 <property name="DBG_OR_KDBG" value="true" />
  37         </if>
  38
  39         <include base="ReactOS">include</include>
  40
  41         <directory name="boot">
  42                 <xi:include href="boot/boot.xml" />
  43         </directory>
  44
  45         <module name="bootcd" type="iso">
  46         </module>
  47 </project>
  48
  49
  50 xi:include
  51 ----------
  52 It is possible to split an xml build file over several files. The include element in the xi namespace is used to accomplish this.
  53
  54 Syntax:
  55         <xi:include href="config.xml">
  56                 <xi:fallback>
  57                         <xi:include href="config.template.xml" />
  58                 </xi:fallback>
  59         </xi:include>
  60
  61 Attributes:
  62         href - Name of xml build file to include. The filename is relative to the location of the current xml build file.
  63
  64 Value:
  65         None.
  66
  67 Elements:
  68         xi:fallback
  69
  70
  71 xi:fallback
  72 -----------
  73 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.
  74
  75 Attributes:
  76         None.
  77
  78 Value:
  79         None.
  80
  81 Elements:
  82         xi:include.
  83
  84
  85 Project element
  86 ---------------
  87 There can be one project per top-level XML build file. A project can only be defined in a top-level xml build file.
  88
  89 Syntax:
  90         <project name="ReactOS" makefile="Makefile.auto" xmlns:xi="http://www.w3.org/2001/XInclude">
  91                 ...
  92         </project>
  93
  94 Attributes:
  95         name - Name of the project.
  96         makefile - Filename of the GNU makefile that is to be created.
  97
  98 Value:
  99         None.
 100
 101 Elements:
 102         define, directory, if, include, module, property
 103
 104
 105 Module element
 106 --------------
 107 There can be zero or more modules per xml build file.
 108
 109 Syntax:
 110         <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" allowwarnings="true" aliasof="module1">
 111                 ...
 112         </module>
 113
 114 Attributes:
 115         if - If the value is 1, then the module is enabled, otherwise it is disabled. A disabled module is not processed.
 116         ifnot - If the value is 1, then the module is disabled, otherwise it is enabled. A disabled module is not processed.
 117         name - Name of the module. Also the base name of the generated file if such file is generated for the particular module type.
 118         type - Type of module. See below for an explanation of module types.
 119         extension - Extension of the generated file if such file is generated for the particular module type.
 120         entrypoint - Entrypoint symbol of the generated file if such file is generated for the particular module type.
 121         baseaddress - Base address of the generated file if such file is generated for the particular module type.
 122         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.
 123         installbase - Base directory of the generated file in the installation directory. This attribute is optional.
 124         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.
 125         usewrc - Use WRC to compile resources if true. If false, windres is used. This attribute is optional. If not specified, WRC will be used.
 126         allowwarnings - 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.
 127         aliasof - Name of module that is aliased.
 128 Value:
 129         None.
 130
 131 Elements:
 132         bootstrap, component, compilationunit, define, dependency, directory, file, if, importlibrary, include, invoke, library, linkerscript, property.
 133
 134
 135 Module types
 136 ------------
 137 The module type determines the actions that is to be carried out to process the module. The defined module types are seen below:
 138         buildtool - Builds a tool that can be run (invoked) when building ReactOS. Default extension is .exe when building on Windows and nothing when building on Linux. The entrypoint, baseaddress, and mangledsymbols module attributes are not applicable for this module type.
 139         staticlibrary - Builds a static library containing object files that can be linked together with other modules. Default extension is .a. The entrypoint, baseaddress, and mangledsymbols module attributes are not applicable for this module type.
 140         objectlibrary - Builds object files that can be linked together with other modules. Default extension is .o. The entrypoint, baseaddress, and mangledsymbols module attributes are not applicable for this module type.
 141         kernel - Builds ntoskrnl.exe. Default extension is .exe. Default entrypoint is _NtProcessStartup.
 142         kernelmodedll - Builds a kernel-mode DLL. Default extension is .dll. Default entrypoint is _DriverEntry@8.
 143         kernelmodedriver - Builds a kernel-mode driver. Default extension is .sys. Default entrypoint is _DriverEntry@8.
 144         nativedll - Builds a native DLL. Default extension is .dll. Default entrypoint is _DllMainCRTStartup@12.
 145         win32dll - Builds a Win32 DLL. Default extension is .dll. Default entrypoint is _DllMain@12.
 146         win32cui - Builds a Win32 console executable. Default extension is .exe. Default entrypoint is _mainCRTStartup. The baseaddress module attribute is not applicable for this module type.
 147         win32gui - Builds a Win32 GUI executable. Default extension is .exe. Default entrypoint is _WinMainCRTStartup. The baseaddress module attribute is not applicable for this module type.
 148         bootloader - Builds a bootloader. The entrypoint, baseaddress, and mangledsymbols module attributes are not applicable for this module type.
 149         bootsector - Builds one or more bootsector binaries. The entrypoint, baseaddress, and mangledsymbols module attributes are not applicable for this module type.
 150         iso - Builds a bootable CD. The entrypoint, baseaddress, and mangledsymbols module attributes are not applicable for this module type.
 151         test - Builds a testsuite. Default extension is .exe. Default entrypoint is _mainCRTStartup. The baseaddress module attribute is not applicable for this module type.
 152         rpcserver - Generates and builds server code for an RPC interface. Default extension is .o. The entrypoint, baseaddress, and mangledsymbols module attributes are not applicable for this module type.
 153         rpcclient - Generates and builds client code for an RPC interface. Default extension is .o. The entrypoint, baseaddress, and mangledsymbols module attributes are not applicable for this module type.
 154         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.
 155
 156
 157 Bootstrap element
 158 -----------------
 159 A bootstrap element specifies that the generated file should be put on the bootable CD as a bootstrap file.
 160
 161 Syntax:
 162         <bootstrap base="reactos" nameoncd="halmp.dll" />
 163
 164 Attributes:
 165         base - Put file in this directory on the bootable CD. This attribute is optional.
 166         nameoncd - Name of file on the bootable CD. This attribute is optional.
 167
 168 Value:
 169         None.
 170
 171 Elements:
 172         None.
 173
 174
 175 CDFile element
 176 --------------
 177 A cdfile element specifies the name of a file that is to be put on the bootable CD.
 178
 179 Syntax:
 180         <cdfile base="reactos" nameoncd="ReadMe.txt">ReadMe.txt</cdfile>
 181
 182 Attributes:
 183         base - Put file in this directory on the bootable CD. This attribute is optional.
 184         nameoncd - Name of file on the bootable CD. This attribute is optional.
 185
 186 Value:
 187         Name of file.
 188
 189 Elements:
 190         None.
 191
 192
 193 CompilationUnit element
 194 -----------------------
 195 A compilationunit element specifies that one or more source code files are to be compiled as a single compilation unit.
 196
 197 Syntax:
 198         <compilationunit name="kernel32.c">
 199                 ...
 200         </compilationunit>
 201
 202 Attributes:
 203         name - Name of generated source code file.
 204
 205 Value:
 206         None.
 207
 208 Elements:
 209         directory, file, if.
 210
 211
 212 Component element
 213 -----------------
 214 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.
 215
 216 Syntax:
 217         <component name="ntdll.dll">
 218                 ...
 219         </component>
 220
 221 Attributes:
 222         name - Name of library.
 223
 224 Value:
 225         None.
 226
 227 Elements:
 228         Symbol.
 229
 230
 231 Symbol element
 232 --------------
 233 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.
 234
 235 Syntax:
 236         <symbol newname="RtlAllocateHeap">HeapAlloc@12</symbol>
 237
 238 Attributes:
 239         newname - New name of symbol. This attribute is optional.
 240
 241 Value:
 242         Name of symbol.
 243
 244 Elements:
 245         None.
 246
 247
 248 Define element
 249 --------------
 250 A define element specifies the name and (optionally) value of a define for the C/C++ compiler and resource compiler.
 251
 252 Syntax:
 253         <define name="WINVER">0x501</define>
 254
 255 Attributes:
 256         name - Name of define.
 257
 258 Value:
 259         Value of define. The value is optional.
 260
 261 Elements:
 262         None.
 263
 264
 265 Dependency element
 266 ------------------
 267 A dependency element specifies the name of a module (usually of type buildtool) that is to be processed before the current module.
 268
 269 Syntax:
 270         <dependency>OtherModule</dependency>
 271
 272 Attributes:
 273         None.
 274
 275 Value:
 276         Name of module.
 277
 278 Elements:
 279         None.
 280
 281
 282 Directory element
 283 -----------------
 284 A directory element specifies the name of a subdirectory.
 285
 286 Syntax:
 287         <directory name="MyDirectory">
 288                 ...
 289         </directory>
 290
 291 Attributes:
 292         name - Name of directory.
 293
 294 Value:
 295         None.
 296
 297 Elements:
 298         cdfile, directory, file, if, property.
 299
 300
 301 File element
 302 ------------
 303 A file element specifies the name of a file that is to be processed.
 304
 305 Syntax:
 306         <file>MyFile.c</file>
 307
 308 Attributes:
 309         None.
 310
 311 Value:
 312         Name of file.
 313
 314 Elements:
 315         None.
 316
 317
 318 If element
 319 ----------
 320 An if element allows for conditional processing of other elements.
 321
 322 Syntax:
 323         <if property="DBG" value="1">
 324                 ...
 325         </if>
 326
 327 Attributes:
 328         property - Name of the property that is to be evaluated.
 329         value - Value to compare to the value of the property. If the property has the specified value, then the subelements are processed.
 330
 331 Value:
 332         None.
 333
 334 Elements:
 335         compilationunit, compilerflag, define, directory, file, if, include, property.
 336
 337
 338 Importlibrary element
 339 ---------------------
 340 An importlibrary element specifies that an import library should be generated which other modules can use to link with the current module.
 341
 342 Syntax:
 343         <importlibrary definition="MyModule.def" />
 344
 345 Attributes:
 346         definition - Filename of definition file (.def) used to generate the import library. The filename is relative to the current module.
 347
 348 Value:
 349         None.
 350
 351 Elements:
 352         None.
 353
 354
 355 Include element
 356 ---------------
 357 An include element specifies an include directory for the C/C++ compiler and resource compiler.
 358
 359 Syntax:
 360         <include base="MyLibraryModule">include</include>
 361
 362 Attributes:
 363         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.
 364
 365 Value:
 366         Relative include directory.
 367
 368 Elements:
 369         None.
 370
 371
 372 Installfile element
 373 -------------------
 374 An installfile element specifies the name of a file that is to be installed when using 'make install'.
 375
 376 Syntax:
 377         <installfile base="reactos" newname="ReadMe.txt">ReadMe.txt</installfile>
 378
 379 Attributes:
 380         base - Put file in this directory within the install directory. This attribute is optional.
 381         newname - Name of file within the install directory. This attribute is optional.
 382
 383 Value:
 384         Name of file.
 385
 386 Elements:
 387         None.
 388
 389
 390 Invoke element
 391 --------------
 392 An invoke element specifies the name of a module which is to be executed before the current module is processed.
 393
 394 Syntax:
 395         <invoke module="wmc">
 396                 <input>
 397                         <inputfile>ntoskrnl.mc</inputfile>
 398                 </input>
 399                 <output>
 400                         <outputfile switches="-H">../include/reactos/bugcodes.h</outputfile>
 401                         <outputfile switches="-o">bugcodes.rc</outputfile>
 402                 </output>
 403         </invoke>
 404
 405 Attributes:
 406         None.
 407
 408 Value:
 409         Name of the module to execute.
 410
 411 Elements:
 412         input, output.
 413
 414
 415 Input element
 416 -------------
 417 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.
 418
 419 Attributes:
 420         None.
 421
 422 Value:
 423         None.
 424
 425 Elements:
 426         inputfile.
 427
 428
 429 Inputfile element
 430 -----------------
 431 An inputfile element specifies a filename that is to be passed as a parameter to a build tool.
 432
 433 Attributes:
 434         switches - Switches that is passed as parameters just before the filename. This attribute is optional.
 435
 436 Value:
 437         Name of file that is to be passed as a parameter to the build tool.
 438
 439 Elements:
 440         None.
 441
 442
 443 Output element
 444 --------------
 445 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.
 446
 447 Attributes:
 448         None.
 449
 450 Value:
 451         None.
 452
 453 Elements:
 454         outputfile.
 455
 456
 457 Outputfile element
 458 ------------------
 459 An outputfile element specifies a filename that is to be passed as a parameter to a build tool.
 460
 461 Attributes:
 462         switches - Switches that is passed as parameters just before the filename. This attribute is optional.
 463
 464 Value:
 465         Name of file that is to be passed as a parameter to the build tool.
 466
 467 Elements:
 468         None.
 469
 470
 471 Library
 472 -------
 473 An importlibrary element specifies the name of another module which is to be linked with the current module.
 474
 475 Syntax:
 476         <library>MyLibraryModule</library>
 477
 478 Attributes:
 479         None.
 480
 481 Value:
 482         Name of the module to link with.
 483
 484 Elements:
 485         None.
 486
 487
 488 Linkerscript
 489 ------------
 490 A linkerscript element specifies the filename of a binutils linker script.
 491
 492 Syntax:
 493         <linkerscript base="mymodule">MyLinkerScript</linkerscript>
 494
 495 Attributes:
 496         base - Module which the value of this element is relative to. This attribute is optional. If left out, the linker script is relative to the position of the top-level xml build file.
 497
 498 Value:
 499         Relative linker script filename.
 500
 501 Elements:
 502         None.
 503
 504
 505 Property
 506 --------
 507 A property element specifies the name and value of a property that can be used for conditional processing of the xml build file.
 508
 509 Syntax:
 510         <property name="mypropertyname" value="mypropertyvalue" />
 511
 512 Attributes:
 513         name - Name of property.
 514         value - Value of property.
 515
 516 Value:
 517         None.
 518
 519 Elements:
 520         None.