user: add a warning not to use special characters in pathnames

Spaces and other specical characters in pathnames break builds of any
software packages using GNU make.

All of the GNU tools and RTEMS use make and this breaks builds. This
is a long standing known issue with GNU make, which can't handle spaces
in pathnames:

https://savannah.gnu.org/bugs/?712

This work was part of GCI 2018.

Probably closes #3450.
This commit is contained in:
Marçal Comajoan Cara 2018-11-14 17:01:14 +01:00 committed by Joel Sherrill
parent e49e4056c7
commit b2a7a5ddbe

View File

@ -63,6 +63,13 @@ proven over the years to be difficult to manage in production systems.
means it is searched first and the RTEMS needed versions of the tools are
used.
.. warning::
Do not put spaces or special characters in the directories you use to build
RTEMS. Many of the packages built by the RSB use GNU *make*, which cannot
handle spaces in pathnames. If there is a space in the pathname the build
will fail. Special characters are also likely to confuse build systems.
.. note::
RSB and RTEMS have a matching *git branch* for each version of RTEMS. For