Removing a BSP

This page describes the process of removing a BSP from the RTEMS source repository. It must be preceded by an announcement to the community in order to allow for feedback that it can be removed or is still in use.

In these instructions, it is assumed that an entire BSP family is removed. Removing one or more BSP variants within a family is likely to require closer attention to configuration and conditional sections or files specific to the BSP variant being removed.

Removing a BSP Family from the Source

A BSP is normally well contained in the c/src/lib/libbsp/@ARCHITECTURE@/@BSP_FAMILY@ directory. Removing it should consist of a few simple steps.

Note that in these instructions, @ARCHITECTURE@ should be replaced with the target architecture for the BSP being removed and @BSP_FAMILY@ is the BSP family. These must be substituted with real names.

File a ticket - This is important so all modifications related to removing this BSP are easy to identify in case the BSP is resurrected.

NOTE: In some cases, the ticket may already be filed and you are just doing the "coding" part of the effort. In this case, use the ticket number already available.

Create a branch in git to make local changes on.

  git checkout -b am 

Remove the BSP family from git - Be sure to include the ticket number in the commit message.

  cd .../c/src/lib/libbsp/@ARCHITECTURE@
  git rm -f @BSP_FAMILY@
  git add .
  git commit 

The commit message for the above should be something like:

@ARCHITECTURE@/@BSP_FAMILY@: Remove

updates #NNNN.

where NNNN is the ticket number for the ticket filed earlier.

Regenerate the acinclude.m4 file in c/src/libbsp/@ARCHITECTURE@

../../../../../bootstrap
git add acinclude.m4
git commit 

The commit message for the above should be something like:

@ARCHITECTURE@/acinclude.m4: Regenerate to remove @BSP_FAMILY@

closes #NNNN.

where NNNN is the ticket number for the ticket filed earlier.

At this point, you should have a git branch named "am" which has two patches. Send these patches to the RTEMS development mailing list. The lines at the bottom of the commit messages will automatically update and close the ticket when the patch is committed.