source: rtems/cpukit/include/rtems/devnull.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.5 KB
Line 
1/**
2 * @file
3 *
4 * @brief RTEMS /dev/null Device Driver
5 *
6 * This include file defines the interface to the RTEMS /dev/null
7 * device driver.
8 */
9
10/*
11 *  Author: Ralf Corsepius (corsepiu@faw.uni-ulm.de)
12 *
13 *  COPYRIGHT (c) 1989-2000.
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_DEVNULL_H
22#define _RTEMS_DEVNULL_H
23
24#include <rtems/io.h>
25
26/**
27 *  @defgroup libmisc_devnull Null Device Driver
28 *
29 *  @ingroup libmisc
30 */
31/**@{*/
32
33#ifdef __cplusplus
34extern "C" {
35#endif
36
37#define DEVNULL_DRIVER_TABLE_ENTRY \
38  { null_initialize, null_open, null_close, null_read, \
39    null_write, null_control }
40
41#define NULL_SUCCESSFUL RTEMS_SUCCESSFUL
42
43rtems_device_driver null_initialize(
44  rtems_device_major_number,
45  rtems_device_minor_number,
46  void *
47);
48
49rtems_device_driver null_open(
50  rtems_device_major_number,
51  rtems_device_minor_number,
52  void *
53);
54
55rtems_device_driver null_close(
56  rtems_device_major_number,
57  rtems_device_minor_number,
58  void *
59);
60
61rtems_device_driver null_read(
62  rtems_device_major_number,
63  rtems_device_minor_number,
64  void *
65);
66
67rtems_device_driver null_write(
68  rtems_device_major_number,
69  rtems_device_minor_number,
70  void *
71);
72
73rtems_device_driver null_control(
74  rtems_device_major_number,
75  rtems_device_minor_number,
76  void *
77);
78
79#ifdef __cplusplus
80}
81#endif
82/**@}*/
83#endif
84/* end of include file */
Note: See TracBrowser for help on using the repository browser.