Difference between revisions of "Building Modules"

From ReactOS Wiki
Jump to: navigation, search
(Reworking: StepbyStep + images.)
Line 1: Line 1:
There are many applications, tests, and extra subsystems in the ReactOS SVN. Most are not included by default and require a few easy steps.
+
== Modules ==
 +
There are many applications, tests, and extra subsystems in the ReactOS SVN.
 +
We don't include them because they're usually not part of everyday's development/testing/use.
 +
 
 +
=== Available Modules ===
 +
We currently have the following modules in the SVN Tree:
 +
 
 +
::::''' rosapps ''' - Various non-core applications, like additional screensavers, devutils and cmdutils.
 +
::::''' rostests ''' - Home of our testing framework( Winetests and Rostests), which includes api conformance tests (both usermode and kernelmode apis), plus the automatic application testing suite (based on autohotkey)
 +
::::'''wallpaper'''  - Several wallpapers for ReactOS Desktop.
 +
 
 +
== Downloading the Modules ==
 +
The following example will show how to download the "rostests" module. To download any other module follow the same steps but using the name of the desired module.
 +
 
 +
'''STEP 1:'''  Find the "reactos\modules"(if you are in Windows) or "reactos/modules"(if you are using Unix) folder
 +
 
 +
[[Image:ReactosModules.png]]
 +
 
 +
'''STEP 2:'''  As we want to download the "rostests" module create a folder named "rostests".
 +
 
 +
'''STEP 3:'''  Right click in that new folder and select checkout("SVN Checkout..")
 +
 
 +
[[Image:RostestCheckout.png]]
  
== Technical Information ==
+
'''STEP 4:''' The "URL of repository" of "rostest" is:  svn://svn.reactos.org/svn/reactos/trunk/rostests
In "reactos/modules" or "reactos\modules", depending on whether you're on a UNIX or Windows system, is ''directory.cmake''. The Build system will read the ''directory.cmake'' file and look if the subfolders named in this file exist.
 
  
If a folder exists, the Build System will process its ''directory.cmake'' file.
+
[[Image:RostestSVN.jpg]]
  
== Integrating a module ==
+
'''STEP 5:'''  Hit OK. It'll begin downloading the needed files. Compile as usual and you'll have the modules integrated in the ISO.
If you want to integrate a module into the build, it's the easiest to copy the appropriate folder into the "modules" directory.
 
  
  
If you already downloaded a module into another directory and want to keep it there (e.g. for updating it via SVN), you can also create a symbolic link to that directory. This also saves disk space.
+
If you want to download the '''rosapps''' or '''wallpaper''' module, just create a ''rosapps'' or ''wallpaper'' folder inside
 +
"reactos/modules" and use the following links as the Url of repository:
 +
              '''Rosapps''': svn://svn.reactos.org/svn/reactos/trunk/rostests
 +
              '''Wallpaper''': svn://svn.reactos.org/svn/reactos/trunk/wallpaper
  
On Windows, a symbolic link can be created on NTFS partitions with the [http://www.microsoft.com/technet/sysinternals/FileAndDisk/Junction.mspx Junction] utility. After you installed this utility, open a Command Prompt, jump to the "modules" directory and execute the following command:
 
  
  junction rosapps X:\reactos\rosapps
+
== Removing a Module ==
  
In this case, I assume that you want to create a symbolic link to the "rosapps" module, which is located at X:\reactos\rosapps.
+
If you '''remove''' a Module folder '''after''' cmake picks it up, it will not notice, until you tell it to ''reconfigure''.
 +
The ''reconfigure'' command depends on the Build System you are using.It could be:
 +
:::: ninja rebuild_cache
 +
:::: nmake rebuild_cache
 +
:::: make rebuild_cache
 +
:::: etc
  
Under Unix-based operating systems such as Linux, you can use the following command to create a symbolic link:
+
== Technical information ==
 +
In  the "reactos/modules" or "reactos\modules" folder, depending on whether you're on a UNIX or Windows system, there is a file called  ''directory.cmake''.
  
ln -s /home/user/reactos/rosapps rosapps
+
The Build system will read the directory.cmake file and look if the subfolders named in this file exist.
 +
If a folder exists, the Build System will process its ''directory.cmake'' file. This way the folder gets integrated into the building process.
  
This example assumes that you want to create a symbolic link to the "rosapps" module, which is located at /home/user/reactos/rosapps.
 
  
== Modules ==
 
We currently have the following modules in the SVN Tree:
 
  
* rosapps - Various non-core applications, like additional screensavers
 
* rostests - Various tests, including ReactOS specific tests and the Wine test suite
 
  
 
[[Category:Building]]
 
[[Category:Building]]
 
[[Category:Tutorial]]
 
[[Category:Tutorial]]

Revision as of 18:42, 22 January 2013

Modules

There are many applications, tests, and extra subsystems in the ReactOS SVN. We don't include them because they're usually not part of everyday's development/testing/use.

Available Modules

We currently have the following modules in the SVN Tree:

rosapps - Various non-core applications, like additional screensavers, devutils and cmdutils.
rostests - Home of our testing framework( Winetests and Rostests), which includes api conformance tests (both usermode and kernelmode apis), plus the automatic application testing suite (based on autohotkey)
wallpaper - Several wallpapers for ReactOS Desktop.

Downloading the Modules

The following example will show how to download the "rostests" module. To download any other module follow the same steps but using the name of the desired module.

STEP 1: Find the "reactos\modules"(if you are in Windows) or "reactos/modules"(if you are using Unix) folder

ReactosModules.png

STEP 2: As we want to download the "rostests" module create a folder named "rostests".

STEP 3: Right click in that new folder and select checkout("SVN Checkout..")

RostestCheckout.png

STEP 4: The "URL of repository" of "rostest" is: svn://svn.reactos.org/svn/reactos/trunk/rostests

RostestSVN.jpg

STEP 5: Hit OK. It'll begin downloading the needed files. Compile as usual and you'll have the modules integrated in the ISO.


If you want to download the rosapps or wallpaper module, just create a rosapps or wallpaper folder inside 
"reactos/modules" and use the following links as the Url of repository:
             Rosapps: svn://svn.reactos.org/svn/reactos/trunk/rostests
             Wallpaper: svn://svn.reactos.org/svn/reactos/trunk/wallpaper


Removing a Module

If you remove a Module folder after cmake picks it up, it will not notice, until you tell it to reconfigure.

The reconfigure command depends on the Build System you are using.It could be:

ninja rebuild_cache
nmake rebuild_cache
make rebuild_cache
etc

Technical information

In the "reactos/modules" or "reactos\modules" folder, depending on whether you're on a UNIX or Windows system, there is a file called directory.cmake.

The Build system will read the directory.cmake file and look if the subfolders named in this file exist. If a folder exists, the Build System will process its directory.cmake file. This way the folder gets integrated into the building process.