[vsipl++] [patch] Quickstart updates for ref-impl

[Stefan Seefeld]

Jules Bergmann wrote:
> Also, what list should I CC csl-docbook patches to?

gnu-internal seems to be the closest match. (I will CC it as I raise
a docbook-related question.)

> Index: doc/quickstart/quickstart.xml
> ===================================================================
> --- doc/quickstart/quickstart.xml	(revision 161463)
> +++ doc/quickstart/quickstart.xml	(working copy)
> @@ -9,6 +9,7 @@
>  [
>   <!ENTITY opl.xml SYSTEM "../csl-docbook/fragments/opl.xml">
>   <!ENTITY gpl.xml SYSTEM "../csl-docbook/fragments/gpl.xml">
> + <!ENTITY bsd.xml SYSTEM "../csl-docbook/fragments/bsd.xml">

Question to everyone: It looks like those 'fragments' are actually
valid xml documents. Is there any particular reason for using external
entities here ? Could we xi:include them instead ?

> +     <section>
> +      <title>C-VSIPL</title>
> +      <para>
> +       A C-VSIPL implementation can be used by Sourcery VSIPL++ to
> +       to implement many functions, including linear algebra, solvers,
> +       and signal processing objects (such as FFT).
> +      </para>

This paragraph appears to contain an extra 'to'.

>      <section>
> @@ -1031,6 +1061,50 @@
>       </varlistentry>
>  
>       <varlistentry>
> +      <term><option>--enable-cvsip</option></term>
> +      <listitem>
> +       <para>
> +        Enable Sourcery VSIPL++ to search for an appropriate
> +	C-VSIP implementation on the platform.  If found, it
> +	will be used to perform linear algebra (matrix-vector
> +	products and solvers) and signal processing (FFT, convolution,
> +	correlation, and FIR).
> +       </para>

I believe this is not entirely correct. In order for it to be used for FFT,
an additional mention in the FFT backend list ('--enable-fft=cvsip') is needed.

> +    <para>
> +     When configuring Sourcery VSIPL++ to be used as the reference
> +     implementation under the BSD license, the following configuration
> +     flags should be used:
> +     <itemizedlist>
> +
> +      <listitem>
> +       <para><option>--enable-ref-impl</option></para>
> +       <para>
> +        Configures Sourcery VSIPL++ to be used as the reference
> +	implementation.  This is necessary, otherwise Sourcery VSIPL++
> +	requires non-BSD files to operate.
> +       </para>
> +      </listitem>
> +
> +      <listitem>
> +       <para><option>--enable-cvsip</option></para>
> +       <para>
> +        Configures Sourcery VSIPL++ to use a C-VSIP library for linear
> +        algebra and signal processing.  This is necessary, otherwise
> +        linear algebra and signal processing functionality will not be
> +        available.
> +       </para>
> +      </listitem>
> +
> +     </itemizedlist>
> +    </para>

As noted above, --enable-fft=cvsip needs to be provided, too.
(Technically, nothing would prevent us from letting --enable-ref-impl
imply the two options --enable-cvsip and --enable-fft=cvsip.)


Thanks,
		Stefan

-- 
Stefan Seefeld
CodeSourcery
stefan at codesourcery.com
(650) 331-3385 x718