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.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
---
 docs/manual/known-issues.txt | 32 ++++++++++++++++++++++++++++++++
 docs/manual/manual.txt       |  2 ++
 2 files changed, 34 insertions(+)
 create mode 100644 docs/manual/known-issues.txt

>>>>> "Thomas" == Thomas Petazzoni <thomas.petazzoni@free-electrons.com> 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 <thomas.petazzoni@free-electrons.com>
 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.

Thomas,

2013/10/6 Thomas Petazzoni <thomas.petazzoni@free-electrons.com>

> 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.
>
> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
> ---
>  docs/manual/known-issues.txt | 32 ++++++++++++++++++++++++++++++++
>  docs/manual/manual.txt       |  2 ++
>  2 files changed, 34 insertions(+)
>  create mode 100644 docs/manual/known-issues.txt
>
> diff --git a/docs/manual/known-issues.txt b/docs/manual/known-issues.txt
> new file mode 100644
> index 0000000..f731f8f
> --- /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 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.
>

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.


> +
> +* 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 9685667..9ae658e 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[]
> --
>

Otherwise, you have my ack:
Acked-by: Samuel Martin <s.martin49@gmail.com>

Regards,

Dear Peter Korsgaard,

On Sun, 06 Oct 2013 20:36:34 +0200, Peter Korsgaard wrote:

>  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