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.

5 files changed, 5 insertions, 264 deletions

diff --git a/cpukit/telnetd/Makefile.am b/cpukit/telnetd/Makefile.am
index d114ba4a3b..e2ae6a92ae 100644
--- a/cpukit/telnetd/Makefile.am
+++ b/cpukit/telnetd/Makefile.am
@@ -2,10 +2,12 @@ include $(top_srcdir)/automake/compile.am
 
 if LIBNETWORKING
 if LIBSHELL
-include_rtemsdir = $(includedir)/rtems
-include_rtems_HEADERS = pty.h telnetd.h passwd.h
-
 project_lib_LIBRARIES = libtelnetd.a
+
+$(PROJECT_LIB)/libtelnetd.a: libtelnetd.a
+	$(INSTALL_DATA) $< $(PROJECT_LIB)/libtelnetd.a
+TMPINSTALL_FILES = $(PROJECT_LIB)/libtelnetd.a
+
 libtelnetd_a_SOURCES = check_passwd.c des.c pty.c telnetd.c
 libtelnetd_a_CPPFLAGS = $(AM_CPPFLAGS)
 endif
@@ -13,5 +15,4 @@ endif
 
 EXTRA_DIST = README
 
-include $(srcdir)/preinstall.am
 include $(top_srcdir)/automake/local.am
diff --git a/cpukit/telnetd/passwd.h b/cpukit/telnetd/passwd.h
deleted file mode 100644
index 8d5c299a5e..0000000000
--- a/cpukit/telnetd/passwd.h
+++ /dev/null
@@ -1,25 +0,0 @@
-/* Define a default password for telnetd here.
- * NOTES:
- *  - this can be overridden at run-time by setting
- *    the "TELNETD_PASSWD" environment variable.
- *    As soon as that variable is set, the new password
- *    is effective - no need to restart telnetd.
- *  - this must be set to an _encrypted_ password, NOT
- *    the cleartext. Use the 'genpw' utility to generate
- *    a password string:
- *
- *    1) Compile 'genpw.c' for the HOST, i.e.
- *         cc -o genpw genpw.c -lcrypt
- *    1) delete an old password definition from this file.
- *    2) run './genpw >> passwd.h'. This will append
- *       a new definition to this file.
- *
- *  - if no password is defined here, no authentication
- *    is needed, i.e. telnet is open to the world.
- *
- *    T. Straumann <strauman@slac.stanford.edu>
- */
-
-/* #undef TELNETD_DEFAULT_PASSWD */
-/* Default password: 'rtems' */
-#define TELNETD_DEFAULT_PASSWD "tduDcyLX12owo"
diff --git a/cpukit/telnetd/preinstall.am b/cpukit/telnetd/preinstall.am
deleted file mode 100644
index 9acb28775a..0000000000
--- a/cpukit/telnetd/preinstall.am
+++ /dev/null
@@ -1,49 +0,0 @@
-## Automatically generated by ampolish3 - Do not edit
-
-if AMPOLISH3
-$(srcdir)/preinstall.am: Makefile.am
-	$(AMPOLISH3) $(srcdir)/Makefile.am > $(srcdir)/preinstall.am
-endif
-
-PREINSTALL_DIRS =
-DISTCLEANFILES = $(PREINSTALL_DIRS)
-
-all-am: $(PREINSTALL_FILES)
-
-PREINSTALL_FILES =
-CLEANFILES = $(PREINSTALL_FILES)
-
-all-local: $(TMPINSTALL_FILES)
-
-TMPINSTALL_FILES =
-CLEANFILES += $(TMPINSTALL_FILES)
-
-$(PROJECT_LIB)/$(dirstamp):
-	@$(MKDIR_P) $(PROJECT_LIB)
-	@: > $(PROJECT_LIB)/$(dirstamp)
-PREINSTALL_DIRS += $(PROJECT_LIB)/$(dirstamp)
-
-if LIBNETWORKING
-if LIBSHELL
-$(PROJECT_INCLUDE)/rtems/$(dirstamp):
-	@$(MKDIR_P) $(PROJECT_INCLUDE)/rtems
-	@: > $(PROJECT_INCLUDE)/rtems/$(dirstamp)
-PREINSTALL_DIRS += $(PROJECT_INCLUDE)/rtems/$(dirstamp)
-
-$(PROJECT_INCLUDE)/rtems/pty.h: pty.h $(PROJECT_INCLUDE)/rtems/$(dirstamp)
-	$(INSTALL_DATA) $< $(PROJECT_INCLUDE)/rtems/pty.h
-PREINSTALL_FILES += $(PROJECT_INCLUDE)/rtems/pty.h
-
-$(PROJECT_INCLUDE)/rtems/telnetd.h: telnetd.h $(PROJECT_INCLUDE)/rtems/$(dirstamp)
-	$(INSTALL_DATA) $< $(PROJECT_INCLUDE)/rtems/telnetd.h
-PREINSTALL_FILES += $(PROJECT_INCLUDE)/rtems/telnetd.h
-
-$(PROJECT_INCLUDE)/rtems/passwd.h: passwd.h $(PROJECT_INCLUDE)/rtems/$(dirstamp)
-	$(INSTALL_DATA) $< $(PROJECT_INCLUDE)/rtems/passwd.h
-PREINSTALL_FILES += $(PROJECT_INCLUDE)/rtems/passwd.h
-
-$(PROJECT_LIB)/libtelnetd.a: libtelnetd.a $(PROJECT_LIB)/$(dirstamp)
-	$(INSTALL_DATA) $< $(PROJECT_LIB)/libtelnetd.a
-TMPINSTALL_FILES += $(PROJECT_LIB)/libtelnetd.a
-endif
-endif
diff --git a/cpukit/telnetd/pty.h b/cpukit/telnetd/pty.h
deleted file mode 100644
index 392bfd0969..0000000000
--- a/cpukit/telnetd/pty.h
+++ /dev/null
@@ -1,76 +0,0 @@
-/*
- * /dev/ptyXX  (A first version for pseudo-terminals)
- *
- *  Author: Fernando RUIZ CASAS (fernando.ruiz@ctv.es)
- *  May 2001
- *
- *  This program is distributed in the hope that it will be useful,
- *  but WITHOUT ANY WARRANTY; without even the implied warranty of
- *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
- */
-
-#ifndef _RTEMS_PTY_H
-#define _RTEMS_PTY_H
-
-#ifdef __cplusplus
-extern "C" {
-#endif	
-
-#include <rtems.h>	
-
-/* Number of ptys to setup */
-extern size_t rtems_pty_maximum_ptys;
-
-/* Return the devname for a free pty slot.
- * If no slot available (socket>=0)
- * then the socket argument is closed
- */
-char * rtems_pty_get(int socket);
-
-
-/* OBSOLETE */
-#define get_pty		rtems_pty_get
-
-rtems_device_driver pty_initialize(
-  rtems_device_major_number  major,
-  rtems_device_minor_number  minor,
-  void                      *arg);
-rtems_device_driver pty_open(
-  rtems_device_major_number major,
-  rtems_device_minor_number minor,
-  void                    * arg);
-rtems_device_driver pty_close(
-  rtems_device_major_number major,
-  rtems_device_minor_number minor,
-  void                    * arg);
-rtems_device_driver pty_read(
-  rtems_device_major_number major,
-  rtems_device_minor_number minor,
-  void                    * arg);
-rtems_device_driver pty_write(
-  rtems_device_major_number major,
-  rtems_device_minor_number minor,
-  void                    * arg);
-rtems_device_driver pty_control(
-  rtems_device_major_number major,
-  rtems_device_minor_number minor,
-  void                    * arg);
-
-
-#define PTY_DRIVER_TABLE_ENTRY \
-       { pty_initialize , pty_open , pty_close , \
-   pty_read , pty_write , pty_control }
-
-/* Internal functions */
-
-int telnet_pty_initialize(void);
-
-int telnet_pty_finalize(void);
-
-char *telnet_get_pty(int);
-
-#ifdef __cplusplus
-}
-#endif	
-
-#endif
diff --git a/cpukit/telnetd/telnetd.h b/cpukit/telnetd/telnetd.h
deleted file mode 100644
index a5c8a187e3..0000000000
--- a/cpukit/telnetd/telnetd.h
+++ /dev/null
@@ -1,110 +0,0 @@
-/*
- *  Original Author: Fernando RUIZ CASAS (fernando.ruiz@ctv.es)
- *  May 2001
- *  Reworked by Till Straumann and .h overhauled by Joel Sherrill.
- *
- * Copyright (c) 2009 embedded brains GmbH and others.
- *
- * embedded brains GmbH
- * Obere Lagerstr. 30
- * D-82178 Puchheim
- * Germany
- * <rtems@embedded-brains.de>
- *
- * The license and distribution terms for this file may be
- * found in the file LICENSE in this distribution or at
- * http://www.rtems.org/license/LICENSE.
- */
-
-#ifndef _RTEMS_TELNETD_H
-#define _RTEMS_TELNETD_H
-
-#include <rtems.h>
-#include <rtems/shell.h>
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-bool rtems_telnetd_login_check(
-  const char *user,
-  const char *passphrase
-);
-
-/**
- * @brief Telnet command type.
- */
-typedef void (*rtems_telnetd_command)(
-  char * /* device name */,
-  void * /* arg */
-);
-
-/**
- * @brief Telnet configuration structure.
- */
-typedef struct {
-  /**
-   * @brief Function invoked for each Telnet connection.
-   *
-   * The first parameter contains the device name.  The second parameter
-   * contains the argument pointer of this configuration table.
-   */
-  rtems_telnetd_command command;
-
-  /**
-   * @brief Argument for command function.
-   */
-  void *arg;
-
-  /**
-   * @brief Task priority.
-   *
-   * If this parameter is equal to zero, then the priority of network task is
-   * used or 100 if this priority is less than two.
-   */
-  rtems_task_priority priority;
-
-  /**
-   * @brief Task stack size.
-   */
-  size_t stack_size;
-
-  /**
-   * @brief Login check function.
-   *
-   * Method used for login checks.  Use @c NULL to disable a login check.
-   */
-  rtems_shell_login_check_t login_check;
-
-  /**
-   * @brief Keep standard IO of the caller.
-   *
-   * Telnet takes over the standard input, output and error associated with
-   * task, if this parameter is set to @c true.  In this case, it will @b not
-   * listen on any sockets.  When this parameter is @c false, Telnet will
-   * create other tasks for the shell which listen on sockets.
-   */
-  bool keep_stdio;
-} rtems_telnetd_config_table;
-
-/**
- * @brief Telnet configuration.
- *
- * The application must provide this configuration table.  It is used by
- * rtems_telnetd_initialize() to configure the Telnet subsystem.  Do not modify
- * the entries after the intialization since it is used internally.
- */
-extern rtems_telnetd_config_table rtems_telnetd_config;
-
-/**
- * @brief Initializes the Telnet subsystem.
- *
- * Uses the application provided @ref rtems_telnetd_config configuration table.
- */
-rtems_status_code rtems_telnetd_initialize(void);
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif