Changes between Initial Version and Version 1 of Developer/Removing_a_BSP


Ignore:
Timestamp:
Nov 2, 2015, 5:53:23 PM (5 years ago)
Author:
Joel Sherrill
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Developer/Removing_a_BSP

    v1 v1  
     1= Removing a BSP =
     2
     3[[TOC(Developer/Removing_a_BSP , depth=2)]]
     4
     5This 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.
     6
     7In 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.
     8
     9== Removing a BSP Family from the Source ==
     10
     11A BSP is normally well contained in the c/src/lib/libbsp/@ARCHITECTURE@/@BSP_FAMILY@ directory. Removing it should consist of a few simple steps.
     12
     13Note 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.
     14
     15''File a ticket'' - This is important so all modifications related to removing this BSP are easy to identify in case the BSP is resurrected.
     16
     17''Create a branch'' in git to make local changes on.
     18
     19{{{
     20  git checkout -b am
     21}}}
     22
     23''Remove the BSP family from git'' - Be sure to include the ticket number in the commit message.
     24 
     25{{{
     26  cd .../c/src/lib/libbsp/@ARCHITECTURE@
     27  git rm -f @BSP_FAMILY@
     28  git add .
     29  git commit
     30}}}
     31
     32The commit message for the above should be something like:
     33
     34{{{
     35@ARCHITECTURE@/@BSP_FAMILY@: Remove
     36
     37updates #NNNN.
     38}}}
     39
     40where NNNN is the ticket number for the ticket filed earlier.
     41
     42''Regenerate the acinclude.m4 file in c/src/libbsp/@ARCHITECTURE@''
     43
     44{{{
     45../../../../../bootstrap
     46git add acinclude.m4
     47git commit
     48}}}
     49
     50The commit message for the above should be something like:
     51
     52{{{
     53@ARCHITECTURE@/acinclude.m4: Regenerate to remove @BSP_FAMILY@
     54
     55closes #NNNN.
     56}}}
     57
     58where NNNN is the ticket number for the ticket filed earlier.
     59
     60At 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.