source: rtems/c/src/lib/libbsp/MERGE.PROCEDURE @ 4d3e70f4

4.11
Last change on this file since 4d3e70f4 was 65c6425, checked in by Joel Sherrill <joel.sherrill@…>, on May 3, 2012 at 5:24:46 PM

Remove CVS Id Strings (manual edits after script)

These modifications were required by hand after running the script.
In some cases, the file names did not match patterns. In others,
the format of the file did not match any common patterns.

  • Property mode set to 100644
File size: 2.9 KB
Line 
1When adding a BSP to the RTEMS tree, there is usually some cleanup
2to be done.
3
4=========================================================================
5
6Add an entry to ACKNOWLEDGEMENTS.
7
8Send letter with permission to distribute the BSP with RTEMS.
9
10Verify all test link.
11
12Remove compilation warnings.
13
14Make sure that all files submitted are really intended to do into
15the distribution. For example, you may have a myfile.S produced by
16gcc -S myfile.c.
17
18=========================================================================
19This section of the file describes how to run the acpolish script to
20check Makefile style and construction compliance.
21
22The BSP's still apply RTEMS's old autoconf configuration. The only thing
23that have changed are some details inside the Makefile.ins and some details
24in make/custom/<bsp>.cfg. Acpolish should be able to convert 4.0.0
25Makefile.in into new style Makefile.ins. However, sometimes acpolish has
26problems/contains bugs, which require manual intervention. There is no tool
27to adapt a BSP's <bsp>.cfg, but this shouldn't be a problem for you.
28
29Therefore, this is my coarse recipe to merge BSPs is:
30
311. Copy a BSP's files and directories to appropriate directories.
32
332. Manually run acpolish on each Makefile.in and check the output, eg:
34cd some_subdir
35 /path_to_RTEMS/tools/update/acpolish < Makefile.old > Makefile.new
36
37Check Makefile.new for correctness, evtl. edit it, then re-run acpolish
38again:
39/path_to_RTEMS/tools/update/acpolish < Makefile.new > Makefile.in
40
41Compare Makefile.new against Makefile.in. These must not differ, if they
42do, edit Makefile.new until the Makefile.in generated by re-running
43acpolish on Makefile.new does not differ from the freshly generated
44Makefile.in. If they differ permanently, then you probably are affected
45bugs in acpolish (This happens for some styles of conditionals).
46
47This sounds much worser than it actually is, because the bugs in acpolish
48only hit very seldom. Furthermore, BSPs normally only contain a few
49Makefile.ins, therefore individually running acpolish should be tolerable.
50
513. If a BSP contains tools, you have to convert its configuration to
52automake manually. Typically these tools are rather simple, therefore a
53tool's configuration applies standard automake Makefile.ams and
54configure.ins. RTEMS should contain enough examples which could serve as
55templates for this (My advice: Try to avoid preinstallation and
56installation to the temporary installation tree whenever possible; Don't
57forget to add all sources which do not get installed by automake
58to automake's EXTRA_DIST, e.g. noinst_SCRIPTS, noinst_DATA have to be added
59to EXTRA_DIST.
60
61Please let me know if you meet problems and if we/I can fix them. I
62consider acpolish to be an internal developer's and maintainer's helper
63script, which was never intended to be of general use, which is why I am
64not much concerned about bugs in it.
65
66Ralf.
67
68=========================================================================
69
Note: See TracBrowser for help on using the repository browser.