Skip to contentSkip to conversation

docs/manual: add a 'Known issues' chapter

PATCH New Thomas Petazzoni 3 participants 4 messages Oct 6, 2013

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 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.

---
 docs/manual/known-issues.txt | 32 ++++++++++++++++++++++++++++++++
 docs/manual/manual.txt       |  2 ++
 2 files changed, 34 insertions(+)
 create mode 100644 docs/manual/known-issues.txt
docs/manual/known-issues.txt new file +32 -0
new file mode 100644
index 0000000..f731f8f
@@ -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 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 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 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.
+
docs/manual/manual.txt +2 -0
index 9685667..9ae658e 100644
@@ -23,6 +23,8 @@ include::working-with.txt[]
 
 include::faq-troubleshooting.txt[]
 
+include::known-issues.txt[]
+
 include::going-further.txt[]
 
 include::developer-guide.txt[]
Signature · 1 line
1.8.1.2
#1 lore raw

PATCH 1/1 docs/manual: add a 'Known issues' chapter

Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line

"Thomas" == Thomas Petazzoni <[email protected]> writes:

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

The uClibc dependencies are already documented in Config.in, but ok.

Thomas> Signed-off-by: Thomas Petazzoni <[email protected]> Thomas> ---

 Thomas>  docs/manual/known-issues.txt | 32 ++++++++++++++++++++++++++++++++
 Thomas>  docs/manual/manual.txt       |  2 ++

Thomas> 2 files changed, 34 insertions(+) Thomas> create mode 100644 docs/manual/known-issues.txt

Thomas> diff --git a/docs/manual/known-issues.txt b/docs/manual/known-issues.txt Thomas> new file mode 100644
Thomas> index 0000000..f731f8f
Thomas> --- /dev/null
Thomas> +++ b/docs/manual/known-issues.txt
Thomas> @@ -0,0 +1,32 @@
Thomas> +// -*- mode:doc; -*-
Thomas> +// vim: set syntax=asciidoc:
Thomas> +
Thomas> +Known issues
Thomas> +============
Thomas> +
Thomas> +* The +ltp-testsuite+ package does not build with the default uClibc

 Thomas> +  configuration used by the Buildroot toolchain backend. The LTP
 Thomas> +  testsuite uses several functions that are considered obsolete, such
 Thomas> +  as sigset() and others. uClibc configuration options such as
 Thomas> +  DO_XSI_MATH, UCLIBC_HAS_OBSOLETE_BSD_SIGNAL and
 Thomas> +  UCLIBC_SV4_DEPRECATED are needed if one wants to build the
 Thomas> +  +ltp-testsuite+ package with uClibc. You need to either a glibc or

s/either/either use/

In all 3 sections.

Thomas> +* The +prboom+ package triggers a compiler failure with the SuperH 4 Thomas> + compiler from Soucery CodeBench, version 2012.09.

I believe we have a lot of other situations with packages triggering internal compiler errors, especially for microblaze and avr32.

Committed with these changes, thanks.

Signature · 1 line
Bye, Peter Korsgaard
#2 lore raw

PATCH 1/1 docs/manual: add a 'Known issues' chapter

Dear Peter Korsgaard,

Quoted 5 lines · Peter Korsgaard

Thomas> +* The +prboom+ package triggers a compiler failure with the SuperH 4 Thomas> + compiler from Soucery CodeBench, version 2012.09.

I believe we have a lot of other situations with packages triggering internal compiler errors, especially for microblaze and avr32.

I agree, but I'm merely documenting the exceptions I've added in my autobuilders script. I'm planning on adding similar exceptions and documentation in this "Known issues" section for the other compiler failures as well.

Best regards,

Thomas

Signature · 3 lines
Thomas Petazzoni, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com
#3 lore raw

PATCH 1/1 docs/manual: add a 'Known issues' chapter

In reply to Thomas Petazzoni

Thomas,

2013/10/6 Thomas Petazzoni <[email protected]>

Quoted 29 lines

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.

---
 docs/manual/known-issues.txt | 32 ++++++++++++++++++++++++++++++++
 docs/manual/manual.txt       |  2 ++
 2 files changed, 34 insertions(+)
 create mode 100644 docs/manual/known-issues.txt
docs/manual/known-issues.txt new file +10 -0
new file mode 100644
index 0000000..f731f8f
@@ -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

docs/manual/known-issues.txt line 20

Quoted 10 lines
docs/manual/known-issues.txt new file +10 -0
+  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 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 a glibc or eglibc based toolchain, or enable the appropriate
+  options in the uClibc configuration.

+

docs/manual/known-issues.txt line 25

Quoted 5 lines
docs/manual/known-issues.txt new file +4 -0
+* The +mrouted+ package does not build with the default uClibc
+  configuration used by the Buildroot toolchain backend. You need to
+  either a glibc or eglibc based toolchain, or enable the appropriate
+  options in the uClibc configuration.

For all these 3 packages that miss options in the default uClibc configuration,
there are comments in the Config.in files mentioning what are these missing options.
It is weird to list them for ltp-testsuite, but not for xfsprog or mrouted.

Quoted 13 lines
docs/manual/known-issues.txt new file +7 -0
+
+* 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.
+
docs/manual/manual.txt +0 -0
index 9685667..9ae658e 100644

docs/manual/manual.txt include::working-with.txt[]

Quoted 9 lines
docs/manual/manual.txt +2 -1
@@ -23,6 +23,8 @@ include::working-with.txt[]
 
 include::faq-troubleshooting.txt[]
 
+include::known-issues.txt[]
+
 include::going-further.txt[]
 
 include::developer-guide.txt[]
--

Otherwise, you have my ack:

Regards,

Signature · 4 lines
Samuel
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.busybox.net/pipermail/buildroot/attachments/20131006/374f25c8/attachment-0001.html>