path: root/documentation/book-enea-linux-release-info/doc/about_release.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<chapter id="relinfo-about-release">
  <title>About This Release</title>

  <para>This release <emphasis><xi:include
  href="../../docsrc_common/pardoc-distro.xml"
  xmlns:xi="http://www.w3.org/2001/XInclude"
  xpointer="element(EneaLinux_REL_NAME/1)" /></emphasis> provides a publicly
  available Enea Linux distribution for a selected set of PPC targets. This
  release is generated from branch <xi:include
  href="../../docsrc_common/pardoc-distro.xml"
  xmlns:xi="http://www.w3.org/2001/XInclude"
  xpointer="element(EneaLinux_BRANCH/1)" /> of applicable git
  repositories.</para>

  <para>Provided contents:<itemizedlist spacing="compact">
      <listitem>
        <para>Source code, recipes, scripts, and documentation for building
        your own Linux kernel, root file system, and cross-compilation
        toolchains (SDKs)</para>
      </listitem>

      <listitem>
        <para>Default configurations for basic Yocto functionality</para>
      </listitem>

      <listitem condition="f_any">
        <para>Feature-specific configurations to optionally add more
        capabilities to the Linux kernel</para>
      </listitem>

      <listitem>
        <para>Pre-built images (kernels, rootfs, dtb) and other binaries
        available for download</para>
      </listitem>

      <listitem condition="eclipse">
        <para>Eclipse executable plus application development tools (ADT) for
        command line and Eclipse</para>
      </listitem>
    </itemizedlist></para>

  <!-- At least one target must be listed otherwise PDF build fails -->

  <para>Supported targets:<itemizedlist spacing="compact">
      <listitem condition="t_p2041">
        <para><xi:include href="../../docsrc_common/pardoc-distro.xml"
        xmlns:xi="http://www.w3.org/2001/XInclude"
        xpointer="element(EneaLinux_TARGET_NAME_P2041/1)" /></para>
      </listitem>

      <listitem condition="t_p3041">
        <para><xi:include href="../../docsrc_common/pardoc-distro.xml"
        xmlns:xi="http://www.w3.org/2001/XInclude"
        xpointer="element(EneaLinux_TARGET_NAME_P3041/1)" /></para>
      </listitem>

      <listitem condition="t_t4240">
        <para><xi:include href="../../docsrc_common/pardoc-distro.xml"
        xmlns:xi="http://www.w3.org/2001/XInclude"
        xpointer="element(EneaLinux_TARGET_NAME_T4240/1)" /></para>
      </listitem>

      <listitem condition="qemu">
        <para>QEMU PPC</para>
      </listitem>
    </itemizedlist></para>

  <para>Kernel configuration:</para>

  <itemizedlist spacing="compact">
    <listitem condition="t_p2041">
      <para>P2041RDB: One kernel flavor (release)</para>
    </listitem>

    <listitem condition="t_p3041">
      <para>P3041DS: One kernel flavor (release)</para>
    </listitem>

    <listitem condition="t_t4240">
      <para>T4240RDB: Two kernel flavors (release &amp; debug)</para>
    </listitem>

    <listitem>
      <para>Low-Latency Desktop (LLD)</para>
    </listitem>
  </itemizedlist>

  <para>Supported host environment:<itemizedlist>
      <listitem>
        <para><xi:include href="../../docsrc_common/pardoc-distro.xml"
        xmlns:xi="http://www.w3.org/2001/XInclude"
        xpointer="element(EneaLinux_HOST_VER/1)" /></para>
      </listitem>
    </itemizedlist></para>

  <para>Supported versions:<itemizedlist spacing="compact">
      <listitem>
        <para>Yocto version <xi:include
        href="../../docsrc_common/pardoc-distro.xml"
        xmlns:xi="http://www.w3.org/2001/XInclude"
        xpointer="element(Yocto_VER/1)" /></para>
      </listitem>

      <listitem>
        <para>poky source version <xi:include
        href="../../docsrc_common/pardoc-distro.xml"
        xmlns:xi="http://www.w3.org/2001/XInclude"
        xpointer="element(Poky_VER/1)" /></para>
      </listitem>

      <listitem>
        <para>gcc version: <xi:include
        href="../../docsrc_common/pardoc-distro.xml"
        xmlns:xi="http://www.w3.org/2001/XInclude"
        xpointer="element(EneaLinux_GCC_VER/1)" /></para>
      </listitem>

      <listitem>
        <para>Linux kernel version for all targets: <xi:include
        href="../../docsrc_common/pardoc-distro.xml"
        xmlns:xi="http://www.w3.org/2001/XInclude"
        xpointer="element(EneaLinux_KERNEL_VER/1)" /></para>
      </listitem>

      <listitem condition="eclipse">
        <para>Eclipse version <xi:include
        href="../../docsrc_common/pardoc-distro.xml"
        xmlns:xi="http://www.w3.org/2001/XInclude"
        xpointer="element(Eclipse_VER/1)" /> <xi:include
        href="../../docsrc_common/pardoc-distro.xml"
        xmlns:xi="http://www.w3.org/2001/XInclude"
        xpointer="element(Eclipse_NAME/1)" /></para>
      </listitem>

      <listitem>
        <para>Package versions: See <xref linkend="relinfo-packages" /></para>
      </listitem>
    </itemizedlist></para>

  <para>Distribution channel:<itemizedlist spacing="compact">
      <listitem>
        <para>All deliverables can be downloaded from <xi:include
        href="../../docsrc_common/pardoc-distro.xml"
        xmlns:xi="http://www.w3.org/2001/XInclude"
        xpointer="element(ULINK_ENEA_LINUX_URL/1)" /></para>
      </listitem>
    </itemizedlist></para>

  <para>Supported features: See <xref
  linkend="relinfo-supported-features" />.</para>

  <para condition="hidden">More details about this release are provided under
  the following topics:<remark>Info This list is currently hidden (same as
  TOC) until we might add useful descriptions of the
  chapters</remark><itemizedlist spacing="compact">
      <listitem>
        <para><xref linkend="relinfo-supported-targets" /></para>
      </listitem>

      <listitem>
        <para><xref linkend="relinfo-packages" /></para>
      </listitem>

      <listitem>
        <para><xref linkend="relinfo-provided-sdk" /></para>
      </listitem>

      <listitem>
        <para><xref linkend="relinfo-provided-drivers" /></para>
      </listitem>

      <listitem>
        <para><xref linkend="relinfo-documentation" /></para>
      </listitem>

      <listitem condition="f_any">
        <para><xref linkend="relinfo-supported-features" /></para>
      </listitem>

      <listitem>
        <para><xref linkend="relinfo-provided-other" /></para>
      </listitem>

      <listitem>
        <para><xref linkend="relinfo-security-fixes" /></para>
      </listitem>

      <listitem>
        <para><xref linkend="relinfo-excluded" /></para>
      </listitem>

      <listitem>
        <para><xref linkend="relinfo-changes" /></para>
      </listitem>

      <listitem>
        <para><xref linkend="enea-linux-sysreq" /></para>
      </listitem>

      <listitem>
        <para><xref linkend="bugs-limitations" /></para>
      </listitem>
    </itemizedlist></para>

  <?hard-pagebreak ?>

  <xi:include href="supported_architectures.xml"
              xmlns:xi="http://www.w3.org/2001/XInclude" />

  <section id="relinfo-packages">
    <title>Provided Packages</title>

    <para><informaltable>
        <tgroup cols="2">
          <colspec align="left" colname="c1" colwidth="3*" />

          <colspec align="left" colname="c2" colwidth="6*" />

          <thead valign="bottom">
            <row>
              <entry>Type of Packages and Provider</entry>

              <entry>Reference</entry>
            </row>
          </thead>

          <tbody>
            <row>
              <entry>Packages in Enea Linux images</entry>

              <entry><para>See the <olink
              targetdoc="book_enea_linux_open_source"
              targetptr="book_enea_linux_open_source"><trademark
              class="registered">Enea</trademark> Linux Open Source
              Report</olink></para></entry>
            </row>

            <row condition="eclipse">
              <entry>Tools in the Eclipse tarball provided with Enea
              Linux</entry>

              <entry><para>See the <olink
              targetdoc="book_enea_linux_eclipse_open_source"
              targetptr="book_enea_linux_eclipse_open_source"><trademark
              class="registered">Enea</trademark> Linux Eclipse Open Source
              Report</olink></para></entry>
            </row>

            <row>
              <entry>Packages provided by Yocto</entry>

              <entry><para>See the <xi:include
              href="../../docsrc_common/pardoc-distro.xml"
              xmlns:xi="http://www.w3.org/2001/XInclude"
              xpointer="element(ULINK_YOCTO_DOWN_URL/1)" />, tab "Release
              Notes"</para></entry>
            </row>
          </tbody>
        </tgroup>
      </informaltable></para>
  </section>

  <section id="relinfo-provided-sdk">
    <title>Provided Toolchain/s (SDK)</title>

    <para>The SDK contains toolchains supporting cross-compilation of
    applications for the targets on an <xi:include
    href="../../docsrc_common/pardoc-distro.xml"
    xmlns:xi="http://www.w3.org/2001/XInclude"
    xpointer="element(EneaLinux_SDK_HOST_ARCH/1)" /> host. See the <olink
    targetdoc="book_enea_linux_users_guide"
    targetptr="book_enea_linux_users_guide"><trademark
    class="registered">Enea</trademark> Linux User's Guide</olink> for
    information on how to build and install a toolchain.<remark>FIXME LATER
    MAYBE: Sorry but 5.0-ppc does not support cross-compilation of 32-bit
    applications for the T4240RDB 64bit target due to bugs in
    Yocto.</remark></para>
  </section>

  <section id="relinfo-provided-drivers">
    <title>Supported Drivers</title>

    <para>No information of supported drivers is provided in this version of
    the Release Information.</para>
  </section>

  <section id="relinfo-documentation">
    <title>Provided Documentation</title>

    <para>The following Enea Linux manuals are available for <xi:include
    href="../../docsrc_common/pardoc-distro.xml"
    xmlns:xi="http://www.w3.org/2001/XInclude"
    xpointer="element(EneaLinux_REL_VER/1)" />:</para>

    <itemizedlist spacing="compact">
      <listitem>
        <para>README.htm - top page of the documentation</para>
      </listitem>

      <listitem>
        <para>README.release - text file describing the release contents,
        installation, and quick getting started</para>
      </listitem>

      <listitem>
        <para><link linkend="book_enea_linux_release_info"><trademark
        class="registered">Enea</trademark> Linux Release Information (this
        document)</link></para>
      </listitem>

      <listitem>
        <para><olink targetdoc="book_enea_linux_users_guide"
        targetptr="book_enea_linux_users_guide"><trademark
        class="registered">Enea</trademark> Linux User's Guide</olink></para>
      </listitem>

      <listitem>
        <para><olink targetdoc="book_enea_linux_open_source"
        targetptr="book_enea_linux_open_source"><trademark
        class="registered">Enea</trademark> Linux Open Source
        Report</olink></para>
      </listitem>

      <listitem condition="eclipse">
        <para><olink targetdoc="book_enea_linux_eclipse_open_source"
        targetptr="book_enea_linux_eclipse_open_source"><trademark
        class="registered">Enea</trademark> Linux Eclipse Open Source
        Report</olink></para>
      </listitem>
    </itemizedlist>

    <para condition="eclipse">The Enea Linux Eclipse tarball and Eclipse Open
    Source Report is inherited from Enea Linux 4.0. How to use Eclipse is
    described inside the <olink targetdoc="book_enea_linux_users_guide"
    targetptr="book_enea_linux_users_guide"><trademark
    class="registered">Enea</trademark> Linux User's Guide</olink>.</para>

    <para condition="eclipse">Eclipse's own documentation is available in
    tarball Enea-Linux-Eclipse_<xi:include
    href="../../docsrc_common/pardoc-distro.xml"
    xmlns:xi="http://www.w3.org/2001/XInclude"
    xpointer="element(EneaLinux_REL_VER_ECLIPSE/1)" />.tar, directory
    <filename>eclipse/readme</filename>.</para>
  </section>

  <?hard-pagebreak ?>

  <xi:include href="supported_features.xml"
              xmlns:xi="http://www.w3.org/2001/XInclude">
    <xi:fallback>INFO: MISSING XINCLUDE CONTENT</xi:fallback>
  </xi:include>

  <section id="relinfo-provided-other">
    <title>Other Provided Functionality</title>

    <para>The functionality in a distribution depends on included packages in
    the default image. In addition to the supported features, the following
    functionality is also available, among other:</para>

    <itemizedlist spacing="compact">
      <listitem condition="t_t4240">
        <para>On target T4240RDB:</para>

        <itemizedlist spacing="compact">
          <listitem>
            <para>SRIO support in user space (NWRITE, NREAD, msg,
            doorbell)</para>
          </listitem>

          <listitem>
            <para>USDPAA</para>
          </listitem>
        </itemizedlist>
      </listitem>

      <listitem condition="pm_smart">
        <para>Smart Package Management</para>
      </listitem>

      <listitem condition="eclipse">
        <para>Eclipse ADT (excl. QEMU) and plug-ins for application
        development: LTTng, Perf, LatencyTOP, PowerTOP, SystemTap</para>
      </listitem>
    </itemizedlist>
  </section>

  <xi:include href="../../../../documentation/book-enea-linux-release-info/doc/security_fixes.xml"
              xmlns:xi="http://www.w3.org/2001/XInclude" />

  <section id="relinfo-excluded">
    <title>Intentional Limitations</title>

    <para>The following functionality supported in other Enea Linux releases
    has been excluded in this release:<itemizedlist spacing="compact">
        <listitem>
          <para>Eclipse plug-ins for image creation (HOB)</para>
        </listitem>

        <listitem>
          <para>Networking features: DPDK vSwitch, DPDK</para>
        </listitem>

        <listitem>
          <para>Real-time features: Fully Preemptible Kernel (FPK) from the
          PREEMPT_RT patch</para>
        </listitem>

        <listitem>
          <para>Memory features: NUMA</para>
        </listitem>
      </itemizedlist></para>
  </section>
</chapter>