source: rtems/cpukit/include/rtems/dumpbuf.h @ 878487b0

5
Last change on this file since 878487b0 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.0 KB
Line 
1/**
2 * @file
3 *
4 * @brief Print a Memory Buffer
5 *
6 * This file defines the interface to the RTEMS methods to print a
7 * memory buffer in a style similar to many ROM monitors and debuggers.
8 */
9
10/*
11 *  COPYRIGHT (c) 1997-2011.
12 *  On-Line Applications Research Corporation (OAR).
13 *
14 *  The license and distribution terms for this file may in
15 *  the file LICENSE in this distribution or at
16 *  http://www.rtems.org/license/LICENSE.
17 */
18
19#ifndef __DUMP_BUFFER_h
20#define __DUMP_BUFFER_h
21
22/**
23 *  @defgroup libmisc_dumpbuf Print Memory Buffer
24 *
25 *  @ingroup libmisc
26 */
27/**@{*/
28#ifdef __cplusplus
29extern "C" {
30#endif
31
32/**
33 * @brief Print memory buffer.
34 *
35 * This method prints @a length bytes beginning at @a buffer in
36 * a nice format similar to what one would expect from a debugger
37 * or ROM monitor.
38 *
39 * @param[in] buffer is the address of the buffer
40 * @param[in] length is the length of the buffer
41 */
42void rtems_print_buffer(
43  const unsigned char *buffer,
44  int                  length
45);
46
47#ifdef __cplusplus
48}
49#endif
50/**@}*/
51#endif
52/* end of include file */
Note: See TracBrowser for help on using the repository browser.