source: rtems/cpukit/include/rtems/rtems-rfs-shell.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.1 KB
Line 
1/**
2 * @file
3 *
4 * @ingroup rtems_rfs
5 * @brief RTEMS File Systems Shell Commands
6 *
7 * RTEMS File Systems Shell commands provide a CLI interface to support and
8 * development of the RFS file system.
9 */
10
11/*
12 *  COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
13 *
14 *  The license and distribution terms for this file may be
15 *  found in the file LICENSE in this distribution or at
16 *  http://www.rtems.org/license/LICENSE.
17 */
18
19#if !defined (_RTEMS_RFS_SHELL_H_)
20#define _RTEMS_RFS_SHELL_H_
21
22#include <stddef.h>
23#include <stdbool.h>
24#include <stdint.h>
25
26/**
27 * The shell command for the RFS debugger.
28 *
29 * @param[in] argc is the argument count.
30 * @param[in] argv is a pointer to the argument variables.
31 *
32 * @retval 0 Successful operation.
33 * @retval error_code An error occurred.
34 */
35int rtems_shell_debugrfs (int argc, char *argv[]);
36
37/**
38 * The shell command for formatting an RFS file system.
39 *
40 * @param[in] argc is the argument count.
41 * @param[in] argv is a pointer to the argument variables.
42 *
43 * @retval 0 Successful operation.
44 * @retval 1 An error occurred.
45 */
46int rtems_shell_rfs_format (int argc, char* argv[]);
47
48#endif
Note: See TracBrowser for help on using the repository browser.