[RTEMS Project] #3254: Reorganize header files to avoid "make preinstall"

[RTEMS trac]

#3254: Reorganize header files to avoid "make preinstall"
-----------------------------+---------------------
 Reporter:  Sebastian Huber  |       Owner:  (none)
     Type:  enhancement      |      Status:  new
 Priority:  normal           |   Milestone:  5.1
Component:  build            |     Version:  5
 Severity:  normal           |  Resolution:
 Keywords:                   |
-----------------------------+---------------------

Comment (by Chris Johns <chrisj@…>):

 In [changeset:"2afb22b7e1ebcbe40373ff7e0efae7d207c655a9/rtems"
 2afb22b/rtems]:
 {{{
 #!CommitTicketReference repository="rtems"
 revision="2afb22b7e1ebcbe40373ff7e0efae7d207c655a9"
 Remove make preinstall

 A speciality of the RTEMS build system was the make preinstall step.  It
 copied header files from arbitrary locations into the build tree.  The
 header files were included via the -Bsome/build/tree/path GCC command
 line option.

 This has at least seven problems:

 * The make preinstall step itself needs time and disk space.

 * Errors in header files show up in the build tree copy.  This makes it
   hard for editors to open the right file to fix the error.

 * There is no clear relationship between source and build tree header
   files.  This makes an audit of the build process difficult.

 * The visibility of all header files in the build tree makes it
   difficult to enforce API barriers.  For example it is discouraged to
   use BSP-specifics in the cpukit.

 * An introduction of a new build system is difficult.

 * Include paths specified by the -B option are system headers.  This
   may suppress warnings.

 * The parallel build had sporadic failures on some hosts.

 This patch removes the make preinstall step.   All installed header
 files are moved to dedicated include directories in the source tree.
 Let @RTEMS_CPU@ be the target architecture, e.g. arm, powerpc, sparc,
 etc.  Let @RTEMS_BSP_FAMILIY@ be a BSP family base directory, e.g.
 erc32, imx, qoriq, etc.

 The new cpukit include directories are:

 * cpukit/include

 * cpukit/score/cpu/@RTEMS_CPU@/include

 * cpukit/libnetworking

 The new BSP include directories are:

 * bsps/include

 * bsps/@RTEMS_CPU@/include

 * bsps/@RTEMS_CPU@/@RTEMS_BSP_FAMILIY@/include

 There are build tree include directories for generated files.

 The include directory order favours the most general header file, e.g.
 it is not possible to override general header files via the include path
 order.

 The "bootstrap -p" option was removed.  The new "bootstrap -H" option
 should be used to regenerate the "headers.am" files.

 Update #3254.
 }}}

--
Ticket URL: <http://devel.rtems.org/ticket/3254#comment:78>
RTEMS Project <http://www.rtems.org/>
RTEMS Project