summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarçal Comajoan Cara <mcomajoancara@gmail.com>2018-11-14 17:01:14 +0100
committerJoel Sherrill <joel@rtems.org>2018-11-16 10:42:41 -0600
commitb2a7a5ddbe4af1ed43e5e4ffea027d40e44fd26c (patch)
tree6ffe174f83e13f68cdfb51f3cb51b826870207ff
parente49e4056c7d4b7fa35881cfc3522c6e038940e84 (diff)
downloadrtems-docs-b2a7a5ddbe4af1ed43e5e4ffea027d40e44fd26c.tar.bz2
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.
-rw-r--r--user/hosts/os.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/user/hosts/os.rst b/user/hosts/os.rst
index 82ff4de..d9fe943 100644
--- a/user/hosts/os.rst
+++ b/user/hosts/os.rst
@@ -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