From 149ebe734fb715b67f67483930726b525c32c4d6 Mon Sep 17 00:00:00 2001
From: Bill Schmidt <wschmidt@linux.ibm.com>
Date: Wed, 14 Apr 2021 15:57:35 -0500
Subject: [PATCH] Add PVIPR 1.0 Errata document

Signed-off-by: Bill Schmidt <wschmidt@linux.ibm.com>
---
 pom.xml                        |   1 +
 pvipr-errata-1.0/bk_main.xml   | 110 +++++++++++++++++++++++
 pvipr-errata-1.0/ch_errata.xml | 110 +++++++++++++++++++++++
 pvipr-errata-1.0/pom.xml       | 155 +++++++++++++++++++++++++++++++++
 4 files changed, 376 insertions(+)
 create mode 100644 pvipr-errata-1.0/bk_main.xml
 create mode 100644 pvipr-errata-1.0/ch_errata.xml
 create mode 100644 pvipr-errata-1.0/pom.xml

diff --git a/pom.xml b/pom.xml
index 95a2307..3d546a4 100644
--- a/pom.xml
+++ b/pom.xml
@@ -19,5 +19,6 @@
                enable all document builds from the top level -->
     <module>Porting_Vector_Intrinsics</module>
     <module>Intrinsics_Reference</module>
+    <module>pvipr-errata-1.0</module>
   </modules>
 </project>
diff --git a/pvipr-errata-1.0/bk_main.xml b/pvipr-errata-1.0/bk_main.xml
new file mode 100644
index 0000000..833e3de
--- /dev/null
+++ b/pvipr-errata-1.0/bk_main.xml
@@ -0,0 +1,110 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Copyright (c) 2021 OpenPOWER Foundation
+
+  Licensed under the GNU Free Documentation License, Version 1.3;
+  with no Invariants Sections, with no Front-Cover Texts,
+  and with no Back-Cover Texts (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.gnu.org/licenses/fdl-1.3.txt
+
+-->
+
+<!-- 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.1.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">
+
+    <title>OpenPOWER PVIPR Errata</title>
+    <subtitle>For POWER Intrinsics Reference v1.5</subtitle>
+
+    <info>
+    <author>
+      <personname>
+          System Software Work Group
+      </personname>
+      <email>syssw-chair@openpowerfoundation.org</email>
+      <affiliation>
+          <orgname>OpenPower Foundation</orgname>
+      </affiliation>
+    </author>
+    <copyright>
+      <year>2021</year>
+      <holder>OpenPOWER Foundation</holder>
+    </copyright>
+    <releaseinfo>Revision 1.0</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, change to "opfExternal" and ask your TSC representative. -->
+    <!-- legalnotice role="apache2" -->
+    <!-- legalnotice role="opfExternal" -->
+    <!-- Following matches the ABI itself -->
+    <legalnotice role="gnuFreeDoc">
+
+      <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>This document provides errata against version 1.0 of the
+      POWER Vector Intrinsics Programming Reference Specification.  These
+      errata should be considered part of said specification until such
+      time as a newer version of the full specification is published.</para>
+      <para>This document is a Non-standard Track, Work Group Note 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>Document Development Guide</citetitle> version
+      &template_version;.  Comments, questions, etc. can be submitted to the
+      public mailing list for the parent specification 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>2021-04-07</date>
+        <revdescription>
+          <itemizedlist spacing="compact">
+            <listitem>
+              <para>Initial draft</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_errata.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>
diff --git a/pvipr-errata-1.0/ch_errata.xml b/pvipr-errata-1.0/ch_errata.xml
new file mode 100644
index 0000000..92b20b2
--- /dev/null
+++ b/pvipr-errata-1.0/ch_errata.xml
@@ -0,0 +1,110 @@
+<!--
+  Copyright (c) 2021 OpenPOWER Foundation
+
+  Licensed under the GNU Free Documentation License, Version 1.3;
+  with no Invariants Sections, with no Front-Cover Texts,
+  and with no Back-Cover Texts (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.gnu.org/licenses/fdl-1.3.txt
+
+-->
+<chapter xmlns="http://docbook.org/ns/docbook"
+xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en"
+xml:id="dbdoclet.50655240_pgfId-1156194">
+
+<title>Errata</title>
+<para>The following sections of version 1.0 of the POWER Vector Intrinsics
+Programming Reference are modified as specified.</para>
+<section>
+  <title>Section 4.2, Built-In Vector Functions</title>
+  <para>
+    <emphasis role="underline">Problem</emphasis>: For intrinsics that
+    represent vector load and store operations, the arguments that
+    represent offsets from a pointer are listed as having type "signed
+    long long."  Although this is correct for 64-bit code, and this is
+    a 64-bit specification, it is recognized that this is not
+    compatible with existing 32-bit implementations.  This can be
+    resolved using the type "signed long" instead, which is 64 bits on
+    a 64-bit system and 32 bits on a 32-bit system.
+  </para>
+  <para>
+    <emphasis role="underline">Resolution</emphasis>: The following
+    changes are incorporated for each of the specified built-in
+    functions.
+    <itemizedlist>
+      <listitem>
+	<para>
+	  <emphasis role="bold">vec_ld</emphasis>: All types in column
+	  <emphasis role="bold">a</emphasis> are changed to <emphasis
+	  role="bold">signed long</emphasis>.
+	</para>
+      </listitem>
+      <listitem>
+	<para>
+	  <emphasis role="bold">vec_lde</emphasis>: All types in column
+	  <emphasis role="bold">a</emphasis> are changed to <emphasis
+	  role="bold">signed long</emphasis>.
+	</para>
+      </listitem>
+      <listitem>
+	<para>
+	  <emphasis role="bold">vec_ldl</emphasis>: All types in column
+	  <emphasis role="bold">a</emphasis> are changed to <emphasis
+	  role="bold">signed long</emphasis>.
+	</para>
+      </listitem>
+      <listitem>
+	<para>
+	  <emphasis role="bold">vec_st</emphasis>: All types in column
+	  <emphasis role="bold">b</emphasis> are changed to <emphasis
+	  role="bold">signed long</emphasis>.
+	</para>
+      </listitem>
+      <listitem>
+	<para>
+	  <emphasis role="bold">vec_ste</emphasis>: All types in column
+	  <emphasis role="bold">b</emphasis> are changed to <emphasis
+	  role="bold">signed long</emphasis>.
+	</para>
+      </listitem>
+      <listitem>
+	<para>
+	  <emphasis role="bold">vec_stl</emphasis>: All types in column
+	  <emphasis role="bold">b</emphasis> are changed to <emphasis
+	  role="bold">signed long</emphasis>.
+	</para>
+      </listitem>
+      <listitem>
+	<para>
+	  <emphasis role="bold">vec_xl</emphasis>: All types in column
+	  <emphasis role="bold">a</emphasis> are changed to <emphasis
+	  role="bold">signed long</emphasis>.
+	</para>
+      </listitem>
+      <listitem>
+	<para>
+	  <emphasis role="bold">vec_xl_be</emphasis>: All types in column
+	  <emphasis role="bold">a</emphasis> are changed to <emphasis
+	  role="bold">signed long</emphasis>.
+	</para>
+      </listitem>
+      <listitem>
+	<para>
+	  <emphasis role="bold">vec_xst</emphasis>: All types in column
+	  <emphasis role="bold">b</emphasis> are changed to <emphasis
+	  role="bold">signed long</emphasis>.
+	</para>
+      </listitem>
+      <listitem>
+	<para>
+	  <emphasis role="bold">vec_xst_be</emphasis>: All types in column
+	  <emphasis role="bold">b</emphasis> are changed to <emphasis
+	  role="bold">signed long</emphasis>.
+	</para>
+      </listitem>
+    </itemizedlist>
+  </para>
+</section>
+</chapter>
diff --git a/pvipr-errata-1.0/pom.xml b/pvipr-errata-1.0/pom.xml
new file mode 100644
index 0000000..aef864c
--- /dev/null
+++ b/pvipr-errata-1.0/pom.xml
@@ -0,0 +1,155 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Copyright (c) 2021 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.
+
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+    <parent>
+
+        <groupId>org.openpowerfoundation.docs</groupId>
+        <artifactId>workgroup-pom</artifactId>
+        <version>1.0.0-SNAPSHOT</version>
+        <relativePath>../pom.xml</relativePath>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>pvipr-1_0-errata</artifactId>
+
+    <packaging>jar</packaging>
+
+   <name>POWER Vector Intrinsics Programming Reference 1.0 Errata</name>
+
+    <properties>
+        <!-- This is set by Jenkins according to the branch. -->
+        <release.path.name></release.path.name>
+        <comments.enabled>0</comments.enabled>
+    </properties>
+    <!-- ################################################ -->
+    <!-- USE "mvn clean generate-sources" to run this POM -->
+    <!-- ################################################ -->
+    <build>
+        <plugins>
+            <plugin>
+
+                <groupId>org.openpowerfoundation.docs</groupId>
+
+                <artifactId>openpowerdocs-maven-plugin</artifactId>
+                <!-- version set in ../pom.xml -->
+                <executions>
+                    <execution>
+                        <id>generate-webhelp</id>
+                        <goals>
+                            <goal>generate-webhelp</goal>
+                        </goals>
+                        <phase>generate-sources</phase>
+                        <configuration>
+                            <!-- These parameters only apply to webhelp -->
+                            <enableDisqus>${comments.enabled}</enableDisqus>
+                            <disqusShortname>openpower-template-guide</disqusShortname>
+                            <enableGoogleAnalytics>1</enableGoogleAnalytics>
+                            <googleAnalyticsId>UA-17511903-1</googleAnalyticsId>
+                            <generateToc>
+                                appendix		toc,title
+                                article/appendix	nop
+                                article   		toc,title
+                                book      		toc,title,figure,table,example,equation
+				book/appendix		nop
+                                book/chapter		nop
+                                chapter   		toc,title
+				chapter/section 	nop
+                                section   		toc
+                                part      		toc,title
+                                reference 		toc,title
+                                set       		toc,title
+                            </generateToc>
+                            <!-- The following elements sets the autonumbering of sections in output for chapter numbers but no numbered sections-->
+                            <sectionAutolabel>1</sectionAutolabel>
+                            <tocSectionDepth>3</tocSectionDepth>
+                            <sectionLabelIncludesComponentLabel>1</sectionLabelIncludesComponentLabel>
+
+                            <webhelpDirname>pvipr-1_0-errata</webhelpDirname>
+
+                            <pdfFilenameBase>pvipr-1_0-errata</pdfFilenameBase>
+
+                            <!-- TODO: Define the appropriate work product type.  These values are defined by the IPR Policy.
+                                       Consult with the Work Group Chair or a Technical Steering Committee member if you have
+                                       questions about which value to select.
+
+                                       If no value is provided below, the document will default to "Work Group Notes".-->
+                            <workProduct>workgroupNotes</workProduct>
+                            <!-- workProduct>workgroupSpecification</workProduct -->
+                            <!-- workProduct>candidateStandard</workProduct -->
+                            <!-- workProduct>openpowerStandard</workProduct -->
+
+                            <!-- TODO: Set the appropriate security policy for the document.  For documents
+                                       which are not "public" this will affect the document title page and
+                                       create a vertical running ribbon on the internal margin of the
+                                       security status in all CAPS.  Values and definitions are formally
+                                       defined by the IPR policy.  A layman's definition follows:
+
+                                       public =	                this document may be shared outside the
+                                                                foundation and thus this setting must be
+                                                                used only when completely sure it allowed
+                                       foundationConfidential = this document may be shared freely with
+                                                                OpenPOWER Foundation members but may not be
+                                                                shared publicly
+                                       workgroupConfidential =  this document may only be shared within the
+                                                                work group and should not be shared with
+                                                                other Foundation members or the public
+
+                                       The appropriate starting security for a new document is "workgroupConfidential". -->
+                            <security>workgroupConfidential</security>
+                            <!-- security>foundationConfidential</security -->
+                            <!-- security>public</security -->
+
+                            <!-- TODO: Set the appropriate work flow status for the document.  For documents
+                                       which are not "published" this will affect the document title page
+                                       and create a vertical running ribbon on the internal margin of the
+                                       security status in all CAPS.  Values and definitions are formally
+                                       defined by the IPR policy.  A layman's definition follows:
+
+                                           published = this document has completed all reviews and has
+                                                       been published
+                                           draft =     this document is actively being updated and has
+                                                       not yet been reviewed
+                                           review =    this document is presently being reviewed
+
+                                       The appropriate starting security for a new document is "draft". -->
+                            <documentStatus>draft</documentStatus>
+                            <!-- documentStatus>review</documentStatus -->
+                            <!-- documentStatus>published</documentStatus -->
+                        </configuration>
+                    </execution>
+                </executions>
+                <configuration>
+                    <!-- These parameters apply to pdf and webhelp -->
+                    <xincludeSupported>true</xincludeSupported>
+                    <sourceDirectory>.</sourceDirectory>
+                    <includes>
+                       bk_main.xml
+                    </includes>
+
+                    <!-- **TODO: Set to the correct project URL.  This likely needs input from the TSC.  -->
+                    <!-- canonicalUrlBase>http://openpowerfoundation.org/docs/template-guide/content</canonicalUrlBase -->
+                    <glossaryCollection>${basedir}/../glossary/glossary-terms.xml</glossaryCollection>
+                    <includeCoverLogo>1</includeCoverLogo>
+                    <coverUrl>www.openpowerfoundation.org</coverUrl>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+</project>