source: rtems/cpukit/include/rtems/rtems/options.h @ e8e914b3

5
Last change on this file since e8e914b3 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.9 KB
Line 
1/**
2 * @file rtems/rtems/options.h
3 *
4 * @defgroup ClassicOptions Classic API Options
5 *
6 * @ingroup ClassicRTEMS
7 * @brief Options Available on Many Directives
8 *
9 * This include file contains information which defines the
10 * options available on many directives.
11 */
12
13/* COPYRIGHT (c) 1989-2008.
14 * On-Line Applications Research Corporation (OAR).
15 *
16 * The license and distribution terms for this file may be
17 * found in the file LICENSE in this distribution or at
18 * http://www.rtems.org/license/LICENSE.
19 */
20
21#ifndef _RTEMS_RTEMS_OPTIONS_H
22#define _RTEMS_RTEMS_OPTIONS_H
23
24#include <rtems/score/basedefs.h>
25
26#ifdef __cplusplus
27extern "C" {
28#endif
29
30/**
31 * @defgroup ClassicOptions Classic API Options
32 *
33 * @ingroup ClassicRTEMS
34 *
35 * This encapsulates functionality related to the options argument
36 * to Classic API blocking operations. The primary option is whether
37 * or not a task is willing to wait for the operation to complete.
38 */
39/**@{*/
40
41/**
42 *  The following type defines the control block used to manage
43 *  option sets.
44 */
45typedef uint32_t   rtems_option;
46
47/**
48 *  The following constants define the individual options which may
49 *  be used to compose an option set.
50 */
51#define RTEMS_DEFAULT_OPTIONS   0x00000000
52
53/**
54 *  This option constants indicates that the task is to wait on resource.
55 */
56#define RTEMS_WAIT      0x00000000
57/**
58 *  This option constants indicates that the task is to not wait on
59 *  the resource.  If it is not available, return immediately with
60 *  a status to indicate unsatisfied.
61 */
62#define RTEMS_NO_WAIT   0x00000001
63
64/**
65 *  This option constants indicates that the task wishes to wait until
66 *  all events of interest are available.
67 */
68#define RTEMS_EVENT_ALL 0x00000000
69
70/**
71 *  This option constants indicates that the task wishes to wait until
72 *  ANY events of interest are available.
73 */
74#define RTEMS_EVENT_ANY 0x00000002
75
76/**@}*/
77
78#ifdef __cplusplus
79}
80#endif
81
82#endif
83/* end of include file */
Note: See TracBrowser for help on using the repository browser.