Commit Graph

13 Commits

Author SHA1 Message Date
Joel Sherrill
152ab750ca cpukit/libmisc/bspcmdline: Change license to BSD-2
Updates #3053.
2022-03-22 11:34:23 -05:00
Sebastian Huber
cfe8f7a9b7 doxygen: Switch @brief and @ingroup
This order change fixes the Latex documentation build via Doxygen.
2020-04-28 09:04:00 +02:00
Chris Johns
2afb22b7e1 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.
2018-01-25 08:45:26 +01:00
Chris Johns
c49985691f Change all references of rtems.com to rtems.org. 2014-03-21 08:10:47 +11:00
Ayush Awasthi
a163882dae libmisc: Doxygen Clean Up Task #1
Conflicts occured durning this patch and modifications in
the repo were favored over the patch.
2013-01-04 13:09:14 -06:00
Mathew Kallada
9ab091e1e4 Header File Doxygen Enhancement Task #2 2012-12-28 10:36:55 -06:00
Mathew Kallada
f5f2676824 libmisc: Doxygen Enhancement Task #1 2012-12-21 11:13:06 -06:00
Joel Sherrill
9b4422a251 Remove All CVS Id Strings Possible Using a Script
Script does what is expected and tries to do it as
smartly as possible.

+ remove occurrences of two blank comment lines
  next to each other after Id string line removed.
+ remove entire comment blocks which only exited to
  contain CVS Ids
+ If the processing left a blank line at the top of
  a file, it was removed.
2012-05-11 08:44:13 -05:00
Ralf Corsepius
b2bbdb9714 Add HAVE_CONFIG_H support to let files receive configure defines. 2010-03-27 05:01:30 +00:00
Ralf Corsepius
f5c405e150 Minimize includes. 2010-03-27 05:01:03 +00:00
Ralf Corsepius
0893220b2a Whitespace removal. 2009-11-29 12:12:39 +00:00
Joel Sherrill
529760865d 2009-08-06 Joel Sherrill <joel.sherrill@oarcorp.com>
* libmisc/bspcmdline/bspcmdline.h, libmisc/bspcmdline/bspcmdline_get.c,
	libmisc/bspcmdline/bspcmdline_getparam.c,
	libmisc/bspcmdline/bspcmdline_getparamraw.c,
	libmisc/bspcmdline/bspcmdline_getparamrhs.c: Add rtems_ as prefix to
	all routines.
2009-08-06 15:21:14 +00:00
Joel Sherrill
34788417b4 2009-08-05 Joel Sherrill <joel.sherrill@oarcorp.com>
* libmisc/bspcmdline/bspcmdline.h, libmisc/bspcmdline/bspcmdline_get.c,
	libmisc/bspcmdline/bspcmdline_getparam.c,
	libmisc/bspcmdline/bspcmdline_getparamraw.c,
	libmisc/bspcmdline/bspcmdline_getparamrhs.c: New files.
	Missed in previous commit.
2009-08-05 20:16:28 +00:00