Difference between revisions of "SBR600 Potential Projects"

From CDOT Wiki
Jump to: navigation, search
Line 1: Line 1:
 
[[Category:SBR600]][[Category:Winter 2012 SBR600]]
 
[[Category:SBR600]][[Category:Winter 2012 SBR600]]
{{Admon/caution|Obsolete! - Winter 2012|Please note that this page contains obsolete content and is being updated for Fall 2013.}}
 
{{Chris Tyler Draft}}
 
  
 
= Introduction =
 
= Introduction =
Line 32: Line 30:
 
= Raspberry Pi Fedora Remix Projects =
 
= Raspberry Pi Fedora Remix Projects =
  
== Package the Raspberry Pi firmware ==
+
== Update the raspberrypi-config package ==
  
The Raspberry Pi ships with some proprietary firmware used by the graphics processing unit (GPU). This firmware should be packaged within Fedora.
+
The raspberrypi-config package contains the default configuration files for Pidora. These files need to be updated to reflect new options available in the Raspberry Pi firmware, as well as options that are not commonly used and may conflict with common use-cases - for example, the current configuration files cause kernel start-up messages to be reported on the serial port. This is rarely used, any may cause conflicts with other devices connected to that port (e.g., LCD displays).
 
 
Expected outcome: a Fedora package containing the Raspberry Pi firmware.
 
  
 
Skills required: packaging
 
Skills required: packaging
Line 42: Line 38:
 
Maximum number of participants: 1
 
Maximum number of participants: 1
  
== Generate an RPM-based Raspberry Pi kernel ==
+
== Kernel Configuration Files ==
  
The Fedora project has a standard RPM kernel package. The Fedora ARM project has extended this package to build separate kernels for various ARM system-on-a-chip (SOC) platforms, generating binary RPM packages for kernel-omap, kernel-tegra, kernel-kirkwood, and so forth. This package should be extended to generate a kernel package for the Broadcom SOC used in the Raspberry Pi (either kernel-raspi or kernel-bcm).
+
The build process for the kernel uses a configuration file to control which kernel capabilities are built into the kernel itself, which are built as loadable modules, and which are not built. The Pidora kernel configuration file is a combination of the RaspberryPi default configuration file and the Fedora configuration file. This project involves reviewing the Pidora kernel configuration to optimize it for the widest possible range of use-cases while ensuring a fairly small kernel image size.
  
In order to create a standard RPM package file, Dracut (initramfs) will need to be properly supported.
+
Skills required: kernel configuration/building, packaging
  
Expected outcome: the Fedora kernel package generates a Raspberry Pi kernel binary RPM.
+
Maximum number of participants: 1
  
Skills required: packaging, kernel building
+
== Profile and Improve RPM and YUM performance on the Pi ==
  
Maximum number of participants: 2 (kernel package, initramfs/dracut setup)
+
RPM/YUM appear to perform slowly on the Pi -- which is appropriate, since the Pi has a slower processor and storage system than most modern PCs -- but the performance can probably be improved. This project involves profileing the RPM/YUM operations to determine which parts of the processing are slowest, and then examining how those parts work to see if any improvements in speed are possible.
  
== Package the Raspberry Pi libraries ==
+
Skills required: profiling, programming, packaging
  
The Raspberry Pi includes a number of proprietary libraries. These libraries are expected to be re-licensed under an open source license in the coming months. These libraries should be packaged ready for inclusion in Fedora; until they are licensed under an open-source license, only the SRPMs should be released.
+
Maximum number of participants: 1
  
Note that the libray headers (-devel package) should be released in source form.
+
== Internationalization Support in Firstboot for Pidora 19 ==
  
Expected outcome: a raspberrypi-firmware (or bcm2835-firmware) package containing the GPU firmware.
+
This project involves taking the Pidora 19 Firstboot package and internationalizing it (making it possible to use multiple language files with Firstboot). Note that Pidora 19 is expected to use a Fedora 18-style Firstboot system (as was used in Pidora 18) rather than the firstboot system used in Fedora 19 and higher.
  
Skills required: packaging
+
Skills required: python, i11n using gettext, packaging
  
 
Maximum number of participants: 1
 
Maximum number of participants: 1
  
== Package the Raspberry Pi kernel utility ==
+
== New Firstboot for Pidora 20 ==
 
 
The Raspi bootloader requires a special header at the start of the kernel file in order to correctly load it into memory. The tool which creates this header needs to be packaged in Fedora.
 
  
Expected outcome: a Fedora package for the Raspberry Pi kernel utility.
+
Firstboot on the Pi varies a bit from firstboot on PCs, because the software isn't installed onto storage in the same way as PCs. This project involves updating the Fedora 20 firstboot package to work with Pidora 20.
  
Skills required: packaging
+
Skills required: python programming, packaging, testing
  
 
Maximum number of participants: 1
 
Maximum number of participants: 1
  
== Modify Grubby to work with the Raspberry Pi kernel ==
+
== Compiler Flags on Pidora ==
 
 
On ARM systems, kernels are shipped as vmlinuz images (as on other platforms). The ''grubby'' utility is a tool which is used to configure the bootloader when a new kernel is installed, by adjusting the appropriate boot configuration (such as grub/grub2/lilo/elilo/...). On ARM systems, grubby generally calls mkimage to generate a uImage file from the vmlinuz file. On the Raspi, it will need to additionally call the Raspberry Pi kernel utility (described above) to convert the uImage into the kernel.img file.
 
  
Expected outcome: patches for grubby submitted upstream; the ARM grubby package will correctly install the Raspi kernel.
+
We're not sure if the compiler flags being used for Pidora are optimal. This project involves building a number of packages with different combinations of compiler flags, observing the results (in terms of binary size and performance) and recommending the optimal set of flags.
  
Skills required: packaging, scripting (bash and/or python), testing/QA
+
Skills required: building, benchmarking
  
 
Maximum number of participants: 1
 
Maximum number of participants: 1
  
== Create the raspi-logos and raspi-fedora-remix-release-notes packages ==
+
== Avahi Configuration for Pidora ==
  
Fedora usually contains three packages that cannot be redistributed with derived (remixed) versions:
+
Avahi (zeroconf) enables discovery of computers without DNS or IP numbers. This project involves configuring Avahi for use on the Pi, so that other computers can connect to it by name without DNS support. This configuration must then be packaged in such a way that it can be included in the Pidora composes without causing conflicts.
* fedora-logos
 
* fedora-release
 
* fedora-release-notes
 
  
Dummy versions of these packages are available, substituting generic- for fedora- (i.e., generic-logos, generic-release, and generic-release-notes).
+
Skills required: testing, packaging
  
The fedora-release package has been replaced by the raspberrypi-fedora-remix-release package.
+
Maximum number of participants: 1
  
This project involves creating a replacement for the other two packages:
+
== Create a Fedpkg-compatible Package Repository for Pidora ==
* raspberrypi-logos -- This package will contain replacements for the Fedora logos, including the Raspberry Pi logo (and possibly the Fedora secondary mark) where appropriate. It would probably also be a good idea to produce a raspberrypi-backgrounds package with Raspberry Pi-branded wallpaper.
 
* raspberrypi-fedora-remix-release-notes -- This package will contain documentation on the Remix, including notes on how to install it on an SD card, trademarks, use of the GPIO controls, etc.
 
  
Expected outcome: two packages.
+
Fedpkg is a tool used to manage Fedora packages using GIT (and http). We'd like to be able to use it for Pidora-specific (non-Fedora) packages as well. To set up Fedpkg, a package database (pkgdb), GIT repository, http repository, and Fedpg configuration will be required. Completion of the various components of this project should result in a usable, RPM-installable Fedpkg configuration for Pidora packages.
  
Skills required: documentation writing, graphics, packaging
+
Skills required: system administration, testing, packaging
  
Maximum number of people: 2 (logos, release notes)
+
Maximum number of participants: 3
  
== Systemd ==
+
== Upstream the Pidora RPM Changes ==
  
In Fedora 15 and later, the ''upstart'' startup system is replaced by ''systemd''. Systemd needs to be tested on the Raspi, and as much as possible, tuned to use as little memory as possible.
+
There are some small changes to the RPM system that have been done for Pidora. These changes need to be included in the upstream version of RPM. This project involves working with upstream to ensure that these changes are in the correct format and included in subsequent releases of RPM.
  
Expected outcome: systemd is tested and ready for use on the Raspi in F17.
+
Skills required: interpersonal skills - negotiation, patch creation, packaging
 
 
Skills required: debugging, sysadmin problem solving, testing/QA
 
  
 
Maximum number of participants: 1
 
Maximum number of participants: 1
  
== Firstboot ==
+
== Wayland ==
  
The ''firstboot'' package asks the user specific questions when the system starts for the first time. Since Raspberry Pi systems are installed by copying the SD card, additional questions should be asked during the first boot -- for example, the root password and timezone should be set. This project involves writing and packaging additional modules for firstboot for use with the Raspi (and potentially other ARM systems).
+
Fedora 20 includes support for the Wayland display system. The RaspberryPi foundation has been working on a Wayland implementation for the Pi. This project involves getting the two to work well together.
  
Expected outcome: changes for firstboot committed upstream, or a package that extends firstboot packaged in Fedora.
+
Skills required: system administration, debugging, possibly some programming, packaging
  
Skills required: scripting (python), packaging
+
Maximum number of participants: 2
 
 
Maximum number of participants: 1
 
  
== Package Scratch ==
+
== Automate Pidora Kernel and Firmware Building ==
  
[http://scratch.mit.edu/ Scratch] is an educational programming environment from MIT. It's not licensed under an OSI-approved license, but the upstream project has indicated a willingness to relicense it. An OSI-approved license should be negotiated, and the software packaged for Fedora.
+
The Raspberry Pi Foundation maintains a kernel fork that is updated frequently. We would like to package kernel and firmware changes on a daily basis, and have these available in a testing repository so that anyone can use them. Periodically, we will select a kernel-firmware combination from this testing repository and make it available as the main Pidora kernel.
  
Expected outcome: a Fedora package of Scratch.
+
Skills required: scripting (python and/or bash), packaging
 
 
Skills required: packaging
 
  
 
Maximum number of participants: 1
 
Maximum number of participants: 1
  
== Package KidsRuby ==
+
== Change raspberrypi-vc Package to Build from Source ==
  
[http://kidsruby.com/download KidsRuby] is an educational programming editor/IDE for Ruby, which should be packaged for Fedora.
+
Originally, the VideoCore IV GPU on the Pi was used with proprietary libraries which were only available in compiled form, so the raspberrypi-vc package was originally set up to package prebuilt binaries and not build from source. The source code for these libraries is now available, and the raspberrypi-vc package should be changed to build from source (this will help with SELinux compatibility).
 
 
Expected outcome: a Fedora package of KidsRuby.
 
  
 
Skills required: packaging
 
Skills required: packaging
Line 147: Line 126:
 
Maximum number of participants: 1
 
Maximum number of participants: 1
  
== Create a SD Card Installation Tool ==
+
== Write an Updated Boot Screen ==
  
The Fedora LiveUSB-Creator tool can run on a Fedora or on a Windows system and can be used to download and install a Fedora live disc image on a USB flash drive. This tool should be adapted so that it can also create an SD card for the Raspberry Pi (and hopefully other devices) -- so that a user can install the Raspberry Pi remix without using commands such as fdisk, dd, and resize2fs.
+
Pidora includes an OpenGL-powered boot screen, which uses the Raspberry Pi Fedora Remix logo. The current code does not use OpenGL very effectively.
  
Note: the liveusb-creator tool goes through a number of setup steps that are not required for an SD card. On the other hand, creating an SD card involves a few steps that are not necessary for a live USB. Therefore it might be appropriate to create a separate tool rather than modifying the liveusb-creator tool. Also, there are other efforts taking place within the Raspberry Pi community which might do the same thing; if one of those efforts reaches a stable release, it might be possible to package that for Fedora.
+
This package should be updated to use OpenGL better and to use the Pidora logo.
  
'''Note:''' Jon Chiappetta has started work on a similar tool -- participants in this project should co-ordinate/work with Jon on this tool (fossjon in #seneca).
+
Skills required: C programming, OpenGL programming, packaging
  
Expected outcome: a Fedora package of a tool to install the Raspi distribution image on an SD card. Ideally, a Windows version as well.
+
Maximum number of participants: 1
  
Skills required: scripting (python), system administration, testing/QA
+
== Update rootfs-resize ==
  
Maximum number of participants: 3 (scripting, Fedora packaging and testing, Windows packaging and testing)
+
The rootfs-resize package resizes the Pidora rootfs after installation. It works with primary partitions, and it works with the NOOBS system, but it doesn't work with a NOOBS-style layout outside of NOOBS (i.e., where the rootfs is placed in an extended partition). This project involves extending rootfs-resize so that it can resize extended and logical partitions as well as primary partitions.
  
== Create the F17 Raspberry Pi image ==
+
Skills required: Python scripting/programming, system administration, packaging
  
Based on feedback on the F14 Raspberry Pi image, create an F17 alpha/beta image for the Raspberry Pi.
+
Maximum number of participants: 1
 
 
This will involve modifying (or creating) a script to produce the Raspi rootfs, putting the rootfs and image into the final format for distribution.
 
 
 
Note: the final version of F17 won't be ready until just after this course ends. The image will need to be based on the F17 alpha/beta package set.
 
 
 
Expected outcome: a F17 image creation script.
 
 
 
Skills required: system administration, scripting, testing/QA
 
 
 
Maximum number of participants: 2 (scripting, testing)
 
  
== Create the Raspi Repositories ==
+
== Bug Tracker for Pidora ==
  
Set up the repositories to distribute the F17 Raspberry Pi remix files, including:
+
Pidora currently uses a Trac instance for bug tracking. However, there is a lot of spammer activity on that system. Implement an effective spam prevention system on Trac, or implement an alternative bug tracking system such as Bugzilla. Document the solution for future maintainability.
* Setting up the signing keys
 
* Creating a standard signing procedure (SOP) for signing
 
* Creating a 'release' package containing the public keys and repo files
 
  
Expected outcome: repos, release package, SOP
+
Skills required: system administration, documentation
  
 
Maximum number of participants: 1
 
Maximum number of participants: 1
  
= Fedora-ARM Projects =
+
== Packaging Pi-compatible Software ==
  
== Set up a Koji Test Hub ==
+
There are a number of Pi-specific software packages that could/should be included in Pidora. Select one, package it, and get it into Fedora (preferred) or directly into Pidora.
  
We have a Koji Hub to run the Fedora ARM build farm. However, we should have a separate hub for testing configurations before deploying them to the production server. This project involves setting up a test hub so that koji hub/builder configurations can be tested independently from the production server.
+
Some packages to get you started:
 +
* Adafruit WebIDE
 +
* Adafruit libraries/tools/etc
 +
* OMXplayer
  
Expected outcome: a koji test server set up on England
+
* Vidcore library compatibility package (symlink farm in /opt/vc)
  
Skills required: system administration
+
* Quick2wire python library
  
Maximum number of participants: 1
+
There are a number of other package requests in the Pidora bug tracking system.
  
== Document YUM Api ==
+
Skills required: packaging
 
 
Yum is written in Python, but the yum API is poorly documented: the usual answer to a question about the API is: "ask Seth Vidal".
 
  
'''This is a hard project.''' Do not take it on unless you are really willing to complete this task.
+
Maximum number of participants: 1 per package (identify the package!)
 
 
Expected outcome: a guide to the yum API.
 
 
 
Skills required: investigation, scripting (python), writing
 
 
 
Maximum number of participants: 2
 

Revision as of 07:47, 24 September 2013


Introduction

This is a list of potential projects related to the SBR600 course that need people.

Students: Please select a project that you're interested in and add an entry to the project table/participants page.

Open Source Community Members: We welcome your recommendations for potential projects. Please create an account on this Wiki and create a description for your proposed project below. Please list your contact info (just an IRC or FAS2 name is OK) as well as links to any related web pages as Resources for the proposed project. (Questions? Ask Chris Tyler).

Notes

Each project listing contains a general description, plus this information:

  • Maximum number of students - Do not exceed this number without approval from your professor.
  • Skills required - This is a rough list of some of the skills required for this project. This list may be incomplete or inaccurate, but it will give you a starting point in evaluating whether this project is a good fit for you. It is not assumed that you will have all of these skills at the outset of the project -- some of them will be picked up as you do the project.
  • Resources - An initial list of computer and information resources to get started on the project.
  • Expected result - A rough indication of what is expected at the conclusion of the project.
  • Initial contacts - Who to initially talk to about this project. These contacts may refer you on to other people with the respective open source communities.

You will have an opportunity to investigate, expand upon, and fine-tune this information as you prepare your initial project plan. For example, you may come up with a more detail list of expected results (deliverables), resources, and contacts during your planning.

Important.png
Individual Deliverables
Note that when multiple people are working on the same project, they will have independent deliverables -- it's not really group work, but rather separate, closely related projects.

Sample Project

This is a sample project stub. You can use the template for Sample Project in order to create a project page for one of the projects listed below. This is how you 'sign-up' for a project.

NOTE: if someone has already created the project page, speak to this person and see if you can join them. If so, simply add your name to the Project Leader(s) section on the project page. Otherwise, you can become a contributor later.

Raspberry Pi Fedora Remix Projects

Update the raspberrypi-config package

The raspberrypi-config package contains the default configuration files for Pidora. These files need to be updated to reflect new options available in the Raspberry Pi firmware, as well as options that are not commonly used and may conflict with common use-cases - for example, the current configuration files cause kernel start-up messages to be reported on the serial port. This is rarely used, any may cause conflicts with other devices connected to that port (e.g., LCD displays).

Skills required: packaging

Maximum number of participants: 1

Kernel Configuration Files

The build process for the kernel uses a configuration file to control which kernel capabilities are built into the kernel itself, which are built as loadable modules, and which are not built. The Pidora kernel configuration file is a combination of the RaspberryPi default configuration file and the Fedora configuration file. This project involves reviewing the Pidora kernel configuration to optimize it for the widest possible range of use-cases while ensuring a fairly small kernel image size.

Skills required: kernel configuration/building, packaging

Maximum number of participants: 1

Profile and Improve RPM and YUM performance on the Pi

RPM/YUM appear to perform slowly on the Pi -- which is appropriate, since the Pi has a slower processor and storage system than most modern PCs -- but the performance can probably be improved. This project involves profileing the RPM/YUM operations to determine which parts of the processing are slowest, and then examining how those parts work to see if any improvements in speed are possible.

Skills required: profiling, programming, packaging

Maximum number of participants: 1

Internationalization Support in Firstboot for Pidora 19

This project involves taking the Pidora 19 Firstboot package and internationalizing it (making it possible to use multiple language files with Firstboot). Note that Pidora 19 is expected to use a Fedora 18-style Firstboot system (as was used in Pidora 18) rather than the firstboot system used in Fedora 19 and higher.

Skills required: python, i11n using gettext, packaging

Maximum number of participants: 1

New Firstboot for Pidora 20

Firstboot on the Pi varies a bit from firstboot on PCs, because the software isn't installed onto storage in the same way as PCs. This project involves updating the Fedora 20 firstboot package to work with Pidora 20.

Skills required: python programming, packaging, testing

Maximum number of participants: 1

Compiler Flags on Pidora

We're not sure if the compiler flags being used for Pidora are optimal. This project involves building a number of packages with different combinations of compiler flags, observing the results (in terms of binary size and performance) and recommending the optimal set of flags.

Skills required: building, benchmarking

Maximum number of participants: 1

Avahi Configuration for Pidora

Avahi (zeroconf) enables discovery of computers without DNS or IP numbers. This project involves configuring Avahi for use on the Pi, so that other computers can connect to it by name without DNS support. This configuration must then be packaged in such a way that it can be included in the Pidora composes without causing conflicts.

Skills required: testing, packaging

Maximum number of participants: 1

Create a Fedpkg-compatible Package Repository for Pidora

Fedpkg is a tool used to manage Fedora packages using GIT (and http). We'd like to be able to use it for Pidora-specific (non-Fedora) packages as well. To set up Fedpkg, a package database (pkgdb), GIT repository, http repository, and Fedpg configuration will be required. Completion of the various components of this project should result in a usable, RPM-installable Fedpkg configuration for Pidora packages.

Skills required: system administration, testing, packaging

Maximum number of participants: 3

Upstream the Pidora RPM Changes

There are some small changes to the RPM system that have been done for Pidora. These changes need to be included in the upstream version of RPM. This project involves working with upstream to ensure that these changes are in the correct format and included in subsequent releases of RPM.

Skills required: interpersonal skills - negotiation, patch creation, packaging

Maximum number of participants: 1

Wayland

Fedora 20 includes support for the Wayland display system. The RaspberryPi foundation has been working on a Wayland implementation for the Pi. This project involves getting the two to work well together.

Skills required: system administration, debugging, possibly some programming, packaging

Maximum number of participants: 2

Automate Pidora Kernel and Firmware Building

The Raspberry Pi Foundation maintains a kernel fork that is updated frequently. We would like to package kernel and firmware changes on a daily basis, and have these available in a testing repository so that anyone can use them. Periodically, we will select a kernel-firmware combination from this testing repository and make it available as the main Pidora kernel.

Skills required: scripting (python and/or bash), packaging

Maximum number of participants: 1

Change raspberrypi-vc Package to Build from Source

Originally, the VideoCore IV GPU on the Pi was used with proprietary libraries which were only available in compiled form, so the raspberrypi-vc package was originally set up to package prebuilt binaries and not build from source. The source code for these libraries is now available, and the raspberrypi-vc package should be changed to build from source (this will help with SELinux compatibility).

Skills required: packaging

Maximum number of participants: 1

Write an Updated Boot Screen

Pidora includes an OpenGL-powered boot screen, which uses the Raspberry Pi Fedora Remix logo. The current code does not use OpenGL very effectively.

This package should be updated to use OpenGL better and to use the Pidora logo.

Skills required: C programming, OpenGL programming, packaging

Maximum number of participants: 1

Update rootfs-resize

The rootfs-resize package resizes the Pidora rootfs after installation. It works with primary partitions, and it works with the NOOBS system, but it doesn't work with a NOOBS-style layout outside of NOOBS (i.e., where the rootfs is placed in an extended partition). This project involves extending rootfs-resize so that it can resize extended and logical partitions as well as primary partitions.

Skills required: Python scripting/programming, system administration, packaging

Maximum number of participants: 1

Bug Tracker for Pidora

Pidora currently uses a Trac instance for bug tracking. However, there is a lot of spammer activity on that system. Implement an effective spam prevention system on Trac, or implement an alternative bug tracking system such as Bugzilla. Document the solution for future maintainability.

Skills required: system administration, documentation

Maximum number of participants: 1

Packaging Pi-compatible Software

There are a number of Pi-specific software packages that could/should be included in Pidora. Select one, package it, and get it into Fedora (preferred) or directly into Pidora.

Some packages to get you started:

  • Adafruit WebIDE
  • Adafruit libraries/tools/etc
  • OMXplayer
  • Vidcore library compatibility package (symlink farm in /opt/vc)
  • Quick2wire python library

There are a number of other package requests in the Pidora bug tracking system.

Skills required: packaging

Maximum number of participants: 1 per package (identify the package!)