source: rtems/cpukit/include/rtems/system.h @ 0fb724a

5
Last change on this file since 0fb724a was 2afb22b, checked in by Chris Johns <chrisj@…>, on 12/23/17 at 07:18:56

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.
  • Property mode set to 100644
File size: 1.3 KB
Line 
1/**
2 * @file
3 *
4 * @brief Information Included in Every Function in the Executive
5 *
6 * This include file contains information that is included in every
7 * function in the executive.  This must be the first include file
8 * included in all internal RTEMS files.
9 */
10
11/*
12 *  COPYRIGHT (c) 1989-2007.
13 *  On-Line Applications Research Corporation (OAR).
14 *
15 *  The license and distribution terms for this file may be
16 *  found in the file LICENSE in this distribution or at
17 *  http://www.rtems.org/license/LICENSE.
18 */
19
20#ifndef _RTEMS_SYSTEM_H
21#define _RTEMS_SYSTEM_H
22
23#include <rtems/score/cpu.h>
24
25/**
26 *  @defgroup ScoreSystem System Information
27 *
28 *  @ingroup Score
29 */
30/**@{*/
31
32#ifdef __cplusplus
33extern "C" {
34#endif
35
36#ifndef ASM
37
38#ifdef RTEMS_POSIX_API
39/** The following is used by the POSIX implementation to catch bad paths.  */
40int POSIX_NOT_IMPLEMENTED( void );
41#endif
42
43/**
44 *  The following is the extern for the RTEMS version string.
45 *
46 *  @note The contents of this string are CPU specific.
47 */
48extern const char _RTEMS_version[];
49
50/**
51 *  The following is the extern for the RTEMS copyright string.
52 */
53extern const char _Copyright_Notice[];
54
55/** This macro defines the maximum length of a Classic API name. */
56#define RTEMS_MAXIMUM_NAME_LENGTH sizeof(rtems_name)
57
58#endif /* ASM */
59
60#ifdef __cplusplus
61}
62#endif
63
64/**@}*/
65#endif
66/* end of include file */
Note: See TracBrowser for help on using the repository browser.