docs/manual: add a 'Known issues' chapter

Add a 'Known issues' chapter, which lists the exceptions I have
currently in the autobuilder scripts to avoid known problems from
occuring. I believe it is more useful to document them rather than
keeping them hidden in my autobuilder script.

[Peter: s/either/either use/]
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>

2 files changed, 34 insertions, 0 deletions

diff --git a/docs/manual/known-issues.txt b/docs/manual/known-issues.txt
new file mode 100644
index 0000000000..4ef8c05cd7
--- /dev/null
+++ b/docs/manual/known-issues.txt
@@ -0,0 +1,32 @@
+// -*- mode:doc; -*-
+// vim: set syntax=asciidoc:
+
+Known issues
+============
+
+* The +ltp-testsuite+ package does not build with the default uClibc
+  configuration used by the Buildroot toolchain backend. The LTP
+  testsuite uses several functions that are considered obsolete, such
+  as sigset() and others. uClibc configuration options such as
+  DO_XSI_MATH, UCLIBC_HAS_OBSOLETE_BSD_SIGNAL and
+  UCLIBC_SV4_DEPRECATED are needed if one wants to build the
+  +ltp-testsuite+ package with uClibc. You need to either use a glibc
+  or eglibc based toolchain, or enable the appropriate options in the
+  uClibc configuration.
+
+* The +xfsprogs+ package does not build with the default uClibc
+  configuration used by the Buildroot toolchain backend. You need to
+  either use a glibc or eglibc based toolchain, or enable the
+  appropriate options in the uClibc configuration.
+
+* The +mrouted+ package does not build with the default uClibc
+  configuration used by the Buildroot toolchain backend. You need to
+  either use a glibc or eglibc based toolchain, or enable the
+  appropriate options in the uClibc configuration.
+
+* The +libffi+ package is not supported on the SuperH 2 and ARC
+  architectures.
+
+* The +prboom+ package triggers a compiler failure with the SuperH 4
+  compiler from Soucery CodeBench, version 2012.09.
+
diff --git a/docs/manual/manual.txt b/docs/manual/manual.txt
index 968566792e..9ae658eecb 100644
--- a/docs/manual/manual.txt
+++ b/docs/manual/manual.txt
@@ -23,6 +23,8 @@ include::working-with.txt[]
 
 include::faq-troubleshooting.txt[]
 
+include::known-issues.txt[]
+
 include::going-further.txt[]
 
 include::developer-guide.txt[]