Programming-Guides/Intrinsics_Reference/bk_main.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
  Copyright (c) 2019 OpenPOWER Foundation
  
  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
  
-->

<!-- The following entity variable is used to reflect the version of the 
     template document master used for building a document.  This value
     should be set by copy of the of template used to create a new
     document and should not be changed.  Use of this value is in
     in the Abstract section in this file. --> 
<!DOCTYPE book [
<!ENTITY template_version "1.0.0">
]>

<book xmlns="http://docbook.org/ns/docbook"
  xmlns:xi="http://www.w3.org/2001/XInclude"
  xmlns:xlink="http://www.w3.org/1999/xlink"
  version="5.0"
  xml:id="bk_main">

    <!-- TODO: Pick a Title for the new document -->
    <title>Power Vector Intrinsic Programming Reference</title>
    <!-- TODO: Either add a subtitle or remove the following line -->
    <!-- subtitle></subtitle -->

    <info>
    <author>
      <!-- TODO: Set to the appropriate owning Work Group, not an individual -->
      <personname>
          System Software Work Group
      </personname>
      <!-- TODO: Set email address of document author to the Work Group Chair -->
      <email>syssw-chair@openpowerfoundation.org</email>
      <affiliation>
          <orgname>OpenPower Foundation</orgname>
      </affiliation>
    </author>
    <copyright>
      <!-- TODO: Set copyright year -->
      <year>2017-2019</year>
      <holder>OpenPOWER Foundation</holder>
    </copyright>
    <!-- TODO: Set the correct document releaseinfo -->
    <releaseinfo>Revision 0.9.2</releaseinfo>
    <productname>OpenPOWER</productname>
    <pubdate/>

    <!-- TODO: Select one of the two following legalnotice role= values:
           "apache2" for an Apache V2 license or 
           "opfExternal" for an official OpenPOWER Foundation external license text.
         If you don't know which one to select, leave as "apache2" -->
    <legalnotice role="apache2">
    <!--legalnotice role="opfExternal"-->

      <annotation>
          <remark>Copyright details are filled in by the template.</remark>
      </annotation>
    </legalnotice>
    
    <!-- TODO: Update the following text with the correct document description (first paragraph),
               Work Group name, and Work Product track (both in second paragraph). -->
    <abstract>
      <para>The purpose of this document is to provide a guide
      for vector programming on OpenPOWER systems, with an emphasis on examples
      of best practices.  It further provides a reference for intrinsics
      provided by compliant compilers on OpenPOWER systems.</para>
      <para>This document is a Non-standard Track, Work Group Specification work product owned by the
      System Software Workgroup and handled in compliance with the requirements outlined in the
      <citetitle>OpenPOWER Foundation Work Group (WG) Process</citetitle> document.  It was
      created using the <citetitle>Master Template Guide</citetitle> version &template_version;.
      Comments, questions, etc. can be submitted to the public mailing list  for this document at 
      <email>syssw-programming-guides@mailinglist.openpowerfoundation.org</email>.</para>
    </abstract>

    <revhistory>
      <!-- TODO: Set the initial version information and clear any old information out -->
      <revision>
        <date>2019-10-23</date>
        <revdescription>
          <itemizedlist spacing="compact">
            <listitem>
              <para>Version 0.9.2: Initial submission to OpenPOWER
	      Systems Software Workgroup.</para>
            </listitem>
          </itemizedlist>
        </revdescription>
      </revision>
      <revision>
        <date>2019-10-13</date>
        <revdescription>
          <itemizedlist spacing="compact">
            <listitem>
              <para>Version 0.9.1: Initial draft for internal
	      review.</para>
            </listitem>
          </itemizedlist>
        </revdescription>
      </revision>
      <revision>
        <date>2018-12-30</date>
        <revdescription>
          <itemizedlist spacing="compact">
            <listitem>
              <para>Version 0.9: Completed initial transfer of appendix
	      information from ELFv2 ABI.</para> 
            </listitem>
          </itemizedlist>
        </revdescription>
      </revision>
      <revision>
        <date>2017-09-25</date>
        <revdescription>
          <itemizedlist spacing="compact">
            <listitem>
              <para>Version 0.8: Initial publication to private GitHub
	      project.</para> 
            </listitem>
          </itemizedlist>
        </revdescription>
      </revision>
     </revhistory>
    </info>

  <!-- The ch_preface.xml file is required by all documents -->
  <xi:include href="../../Docs-Master/common/ch_preface.xml"/>

  <!-- TODO: Add your chapter heading files here.  Remove both files and insert your own. -->
  <!--       See the template document for naming conventions and location of files.      -->
  <!-- xi:include href="ch_template_overview.xml"/ -->
  <xi:include href="ch_intro.xml"/>
  <xi:include href="ch_biendian.xml"/>
  <xi:include href="ch_techniques.xml"/>
  <xi:include href="ch_vec_reference.xml"/>
  <!-- xi:include href="ch_scal_reference.xml"/ -->
  <xi:include href="ch_isa_intrin_xref.xml"/>
  <!-- xi:include href="app_a.xml"/ -->

  <!-- The app_foundation.xml appendix file is required by all documents. -->
  <xi:include href="../../Docs-Master/common/app_foundation.xml"/>

  <!-- TODO: The following template document may be modified to create additional appendices as needed. -->
  <!-- xi:include href="app_template.xml"/ -->

</book>