source: rtems/cpukit/include/rtems/version.h @ 2afb22b

5
Last change on this file since 2afb22b 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 Version API.
5 */
6
7/*
8 *  Copyright (C) 2017.
9 *  Chris Johns <chrisj@rtems.org>
10 *
11 *  The license and distribution terms for this file may be
12 *  found in the file LICENSE in this distribution or at
13 *  http://www.rtems.org/license/LICENSE.
14 */
15
16#ifndef _RTEMS_VERSION_H
17#define _RTEMS_VERSION_H
18
19#ifdef __cplusplus
20extern "C" {
21#endif
22
23/**
24 * @defgroup ClassicVersion Version
25 *
26 * @ingroup ClassicVersion
27 *
28 * @brief The Version API provides functions to return the version or parts of
29 * the version of RTEMS you are using.
30 */
31/**@{**/
32
33/**
34 * @brief Returns the version string.
35 *
36 * @retval text The version as a string.
37 */
38const char *rtems_version( void );
39
40/**
41 * @brief Returns the version's major number.
42 *
43 * @retval int The version's major number.
44 */
45int rtems_version_major( void );
46
47/**
48 * @brief Returns the version's minor number.
49 *
50 * @retval int The version's minor number.
51 */
52int rtems_version_minor( void );
53
54/**
55 * @brief Returns the version's revision number.
56 *
57 * @retval int The version's revision number.
58 */
59int rtems_version_revision( void );
60
61/**
62 * @brief Returns the version control key for the current version of code that
63 * has been built. The key is specific to the version control system being used
64 * and allows the built version to be identified.
65 *
66 * @retval int The version's version control key.
67 */
68const char *rtems_version_control_key( void );
69
70/** @} */
71
72#ifdef __cplusplus
73}
74#endif
75
76#endif
77/* end of include file */
Note: See TracBrowser for help on using the repository browser.