GSoC Getting Started

GSoC 2008 was the first time the RTEMS Project participated in the Google Summer of Code. After talking to mentors from other projects, we noticed that we all suffered from a "getting started" issue. You are more likely to have a successful project for any organization in GSoC if you are able to build their code, run their examples and make minor modifications. The quicker you cross this hurdle, the sooner you will be doing "real" work.

Please join the rtems-users and rtems-devel mailing lists and speak up. Ask questions. Help correct any deficiency in code or documentation you spot, including on the wiki. The ultimate goal of GSoC is not money, it is getting students to become part of the open source community.

Configure a Development Computer

You will be best served by using a Virtual Machine image with a Linux distribution installed. We provide such an image that uses Virtual Box? and should run on most modern computers.

If you use GNU/Linux or MacOS and are familiar with using it for development, the RTEMS Source Builder? is the best way to get a working tool set. While RTEMS Project also provides RPM based prebuilt tools for some GNU/Linux distributions especially Fedora and CentOS, these tools are not as up-to-date as you can get from building with the RSB. You can find directions on the documentation for the RSB.

This step involves the following steps.

• Install or update GNU/Linux distribution as needed.

• Install RTEMS Tools. See RSB? for information and ask questions on the rtems-users mailing list if you have trouble with this step.

As you will be compiling code, it is recommended to have a reasonably fast machine.

Configure and Build RTEMS for SPARC/SIS

• Check out RTEMS from Git. See RTEMS Git Repository? for information. Make sure you use the git master branch and the tools for the master (as of Feb 2014 these are the rtems-4.11 tools).

• Bootstrap and then build RTEMS for SPARC/sis. See Quick Start?.

• Run hello world example in source tree.

• Install RTEMS.

The gdb session with the unmodified hello world will look something like the following (should have your user name and newer version of RTEMS):

Note that this image is careful not to show you how to configure or build the executable being run.

Configure and Build RTEMS for "Preferred" BSP

The preferred BSP depends on your project but your first choice should be a BSP that runs on a simulator included in gdb. SPARC/sis is a good candidate because it is easy to work with. If your project requires a BSP to support TCP/IP of something else not supported by SPARC/sis, then still first try a simple environment like SPARC/sis and then move on to the one that will support your project. Discuss your project requirements on the RTEMS mailing list and let the community help point you in the right direction.

If SPARC/sis is not the right test platform for your project then you will need to ensure you know how to run hello world on your preferred BSP.

Prove You Can Work On RTEMS

Modify the hello world example to include your name. Something like "Hello Fred!". Then send us enough to prove to us that you did this. We want to know you can work with RTEMS.

Create a patch of your changes: see Contributing? and Git?. This will look like:

diff --git a/testsuites/samples/hello/init.c b/testsuites/samples/hello/init.c
index 8874030..dda8175 100644
--- a/testsuites/samples/hello/init.c
+++ b/testsuites/samples/hello/init.c
@@ -33,9 +33,10 @@ rtems_task Init(
   rtems_task_argument ignored
 )
 {
-  printf( "\n\n*** HELLO WORLD TEST ***\n" );
-  printf( "Hello World\n" );
-  printf( "*** END OF HELLO WORLD TEST ***\n" );
+  printf( "\n\n*** GSOC HELLO WORLD TEST ***\n" );
+  printf( "This is Joel's Hello World\n" );
+  printf( "Welcome to RTEMS and Google Summer of Code 2009\n" );
+  printf( "*** END OF GSOC HELLO WORLD TEST ***\n" );
   exit( 0 );
 }

• Take a "snapshot" of your modified hello world and send us the png. On GNU/Linux, you should be able to press the "Prnt Scrn" button or use the "xwd" command. This is a snapshot that Joel Sherrill took after running the hello world program with the above changes.

Send patch and screenshot

Ask on the mailing list about how to submit the proof. We want you to be open and active.

Other targets

If your project requires more of a test environment than SPARC/sis provides, then repeat the hello world steps on the BSP we help you select. If your project involves developing a new BSP, then you may want to run on a BSP from the same target architecture on a simulator. Again we will help you select the BSP.

We will assist you in anyway possible along the way. We want you to have a functional RTEMS Development Environment as soon as possible so you can move on to the real project.

Interact

Check out the RTEMSSummerOfCode page. Join the IRC channel and mailing lists. Become part of the RTEMS community. Talk to potential mentors, and check out the open projects if you have not already done so.