Bill Schmidt
5 years ago
30 changed files with 9133 additions and 0 deletions
@ -0,0 +1,176 @@
@@ -0,0 +1,176 @@
|
||||
|
||||
Apache License |
||||
Version 2.0, January 2004 |
||||
http://www.apache.org/licenses/ |
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION |
||||
|
||||
1. Definitions. |
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction, |
||||
and distribution as defined by Sections 1 through 9 of this document. |
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by |
||||
the copyright owner that is granting the License. |
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all |
||||
other entities that control, are controlled by, or are under common |
||||
control with that entity. For the purposes of this definition, |
||||
"control" means (i) the power, direct or indirect, to cause the |
||||
direction or management of such entity, whether by contract or |
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the |
||||
outstanding shares, or (iii) beneficial ownership of such entity. |
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity |
||||
exercising permissions granted by this License. |
||||
|
||||
"Source" form shall mean the preferred form for making modifications, |
||||
including but not limited to software source code, documentation |
||||
source, and configuration files. |
||||
|
||||
"Object" form shall mean any form resulting from mechanical |
||||
transformation or translation of a Source form, including but |
||||
not limited to compiled object code, generated documentation, |
||||
and conversions to other media types. |
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or |
||||
Object form, made available under the License, as indicated by a |
||||
copyright notice that is included in or attached to the work |
||||
(an example is provided in the Appendix below). |
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object |
||||
form, that is based on (or derived from) the Work and for which the |
||||
editorial revisions, annotations, elaborations, or other modifications |
||||
represent, as a whole, an original work of authorship. For the purposes |
||||
of this License, Derivative Works shall not include works that remain |
||||
separable from, or merely link (or bind by name) to the interfaces of, |
||||
the Work and Derivative Works thereof. |
||||
|
||||
"Contribution" shall mean any work of authorship, including |
||||
the original version of the Work and any modifications or additions |
||||
to that Work or Derivative Works thereof, that is intentionally |
||||
submitted to Licensor for inclusion in the Work by the copyright owner |
||||
or by an individual or Legal Entity authorized to submit on behalf of |
||||
the copyright owner. For the purposes of this definition, "submitted" |
||||
means any form of electronic, verbal, or written communication sent |
||||
to the Licensor or its representatives, including but not limited to |
||||
communication on electronic mailing lists, source code control systems, |
||||
and issue tracking systems that are managed by, or on behalf of, the |
||||
Licensor for the purpose of discussing and improving the Work, but |
||||
excluding communication that is conspicuously marked or otherwise |
||||
designated in writing by the copyright owner as "Not a Contribution." |
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity |
||||
on behalf of whom a Contribution has been received by Licensor and |
||||
subsequently incorporated within the Work. |
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of |
||||
this License, each Contributor hereby grants to You a perpetual, |
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable |
||||
copyright license to reproduce, prepare Derivative Works of, |
||||
publicly display, publicly perform, sublicense, and distribute the |
||||
Work and such Derivative Works in Source or Object form. |
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of |
||||
this License, each Contributor hereby grants to You a perpetual, |
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable |
||||
(except as stated in this section) patent license to make, have made, |
||||
use, offer to sell, sell, import, and otherwise transfer the Work, |
||||
where such license applies only to those patent claims licensable |
||||
by such Contributor that are necessarily infringed by their |
||||
Contribution(s) alone or by combination of their Contribution(s) |
||||
with the Work to which such Contribution(s) was submitted. If You |
||||
institute patent litigation against any entity (including a |
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work |
||||
or a Contribution incorporated within the Work constitutes direct |
||||
or contributory patent infringement, then any patent licenses |
||||
granted to You under this License for that Work shall terminate |
||||
as of the date such litigation is filed. |
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the |
||||
Work or Derivative Works thereof in any medium, with or without |
||||
modifications, and in Source or Object form, provided that You |
||||
meet the following conditions: |
||||
|
||||
(a) You must give any other recipients of the Work or |
||||
Derivative Works a copy of this License; and |
||||
|
||||
(b) You must cause any modified files to carry prominent notices |
||||
stating that You changed the files; and |
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works |
||||
that You distribute, all copyright, patent, trademark, and |
||||
attribution notices from the Source form of the Work, |
||||
excluding those notices that do not pertain to any part of |
||||
the Derivative Works; and |
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its |
||||
distribution, then any Derivative Works that You distribute must |
||||
include a readable copy of the attribution notices contained |
||||
within such NOTICE file, excluding those notices that do not |
||||
pertain to any part of the Derivative Works, in at least one |
||||
of the following places: within a NOTICE text file distributed |
||||
as part of the Derivative Works; within the Source form or |
||||
documentation, if provided along with the Derivative Works; or, |
||||
within a display generated by the Derivative Works, if and |
||||
wherever such third-party notices normally appear. The contents |
||||
of the NOTICE file are for informational purposes only and |
||||
do not modify the License. You may add Your own attribution |
||||
notices within Derivative Works that You distribute, alongside |
||||
or as an addendum to the NOTICE text from the Work, provided |
||||
that such additional attribution notices cannot be construed |
||||
as modifying the License. |
||||
|
||||
You may add Your own copyright statement to Your modifications and |
||||
may provide additional or different license terms and conditions |
||||
for use, reproduction, or distribution of Your modifications, or |
||||
for any such Derivative Works as a whole, provided Your use, |
||||
reproduction, and distribution of the Work otherwise complies with |
||||
the conditions stated in this License. |
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise, |
||||
any Contribution intentionally submitted for inclusion in the Work |
||||
by You to the Licensor shall be under the terms and conditions of |
||||
this License, without any additional terms or conditions. |
||||
Notwithstanding the above, nothing herein shall supersede or modify |
||||
the terms of any separate license agreement you may have executed |
||||
with Licensor regarding such Contributions. |
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade |
||||
names, trademarks, service marks, or product names of the Licensor, |
||||
except as required for reasonable and customary use in describing the |
||||
origin of the Work and reproducing the content of the NOTICE file. |
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or |
||||
agreed to in writing, Licensor provides the Work (and each |
||||
Contributor provides its Contributions) on an "AS IS" BASIS, |
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or |
||||
implied, including, without limitation, any warranties or conditions |
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A |
||||
PARTICULAR PURPOSE. You are solely responsible for determining the |
||||
appropriateness of using or redistributing the Work and assume any |
||||
risks associated with Your exercise of permissions under this License. |
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory, |
||||
whether in tort (including negligence), contract, or otherwise, |
||||
unless required by applicable law (such as deliberate and grossly |
||||
negligent acts) or agreed to in writing, shall any Contributor be |
||||
liable to You for damages, including any direct, indirect, special, |
||||
incidental, or consequential damages of any character arising as a |
||||
result of this License or out of the use or inability to use the |
||||
Work (including but not limited to damages for loss of goodwill, |
||||
work stoppage, computer failure or malfunction, or any and all |
||||
other commercial damages or losses), even if such Contributor |
||||
has been advised of the possibility of such damages. |
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing |
||||
the Work or Derivative Works thereof, You may choose to offer, |
||||
and charge a fee for, acceptance of support, warranty, indemnity, |
||||
or other liability obligations and/or rights consistent with this |
||||
License. However, in accepting such obligations, You may act only |
||||
on Your own behalf and on Your sole responsibility, not on behalf |
||||
of any other Contributor, and only if You agree to indemnify, |
||||
defend, and hold each Contributor harmless for any liability |
||||
incurred by, or claims asserted against, such Contributor by reason |
||||
of your accepting any such warranty or additional liability. |
||||
|
||||
@ -0,0 +1,95 @@
@@ -0,0 +1,95 @@
|
||||
# OpenPOWER Foundation Documentation Development Guide |
||||
This repository holds the source for the documentation development guide |
||||
(formerly *Master Template Document*) for |
||||
OpenPOWER Foundation. The PDF and HTML generated from the doc/template/ |
||||
directory build a document that both describes how to build a new |
||||
document and contains examples and directions on how to do it. |
||||
|
||||
To build this project, one must ensure that the Docs-Master project has |
||||
also been cloned at the same directory level as the Docs-Template project. |
||||
This can be accomplished with the following steps: |
||||
|
||||
1. Clone the master documentation project (Docs-Master) using the following command: |
||||
|
||||
``` |
||||
$ git clone https://github.com/OpenPOWERFoundation/Docs-Master.git |
||||
``` |
||||
|
||||
2. Clone this project (Docs-Template) using the following command: |
||||
|
||||
``` |
||||
$ git clone https://github.com/OpenPOWERFoundation/Docs-Template.git |
||||
``` |
||||
|
||||
3. Build the project with these commands: |
||||
``` |
||||
$ cd Docs-Template |
||||
$ mvn clean generate-sources |
||||
``` |
||||
|
||||
The online version of the document can be found in the OpenPOWER Foundation |
||||
Document library at [OpenPOWER Foundation Documentation Development Guide](http://openpowerfoundation.org/?resource_lib=openpower-foundation-documentation-development-guide). |
||||
|
||||
The project which controls the look and feel of the document is the |
||||
[Docs-Maven-Plugin project](https://github.com/OpenPOWERFoundation/Docs-Maven-Plugin), an |
||||
OpenPOWER Foundation private project on GitHub. To obtain access to the Maven Plugin project, |
||||
contact Jeff Scheel \([scheel@us.ibm.com](mailto://scheel@us.ibm.com)\) or |
||||
Jeff Brown \([jeffdb@us.ibm.com](mailto://jeffdb@us.ibm.com)\). |
||||
|
||||
## License |
||||
This project is licensed under the Apache V2 license. More information |
||||
can be found in the LICENSE file or online at |
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0 |
||||
|
||||
## Contributions |
||||
To contribute to the OpenPOWER Foundation template document project, contact Jeff Scheel \([scheel@us.ibm.com](mailto://scheel@us.ibm.com)\) or |
||||
Jeff Brown \([jeffdb@us.ibm.com](mailto://jeffdb@us.ibm.com)\). |
||||
|
||||
Contributions to this project should conform to the `Developer Certificate |
||||
of Origin` as defined at http://elinux.org/Developer_Certificate_Of_Origin. |
||||
Commits to this project need to contain the following line to indicate |
||||
the submitter accepts the DCO: |
||||
``` |
||||
Signed-off-by: Your Name <your_email@domain.com> |
||||
``` |
||||
By contributing in this way, you agree to the terms as follows: |
||||
``` |
||||
Developer Certificate of Origin |
||||
Version 1.1 |
||||
|
||||
Copyright (C) 2004, 2006 The Linux Foundation and its contributors. |
||||
660 York Street, Suite 102, |
||||
San Francisco, CA 94110 USA |
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies of this |
||||
license document, but changing it is not allowed. |
||||
|
||||
|
||||
Developer's Certificate of Origin 1.1 |
||||
|
||||
By making a contribution to this project, I certify that: |
||||
|
||||
(a) The contribution was created in whole or in part by me and I |
||||
have the right to submit it under the open source license |
||||
indicated in the file; or |
||||
|
||||
(b) The contribution is based upon previous work that, to the best |
||||
of my knowledge, is covered under an appropriate open source |
||||
license and I have the right under that license to submit that |
||||
work with modifications, whether created in whole or in part |
||||
by me, under the same open source license (unless I am |
||||
permitted to submit under a different license), as indicated |
||||
in the file; or |
||||
|
||||
(c) The contribution was provided directly to me by some other |
||||
person who certified (a), (b) or (c) and I have not modified |
||||
it. |
||||
|
||||
(d) I understand and agree that this project and the contribution |
||||
are public and that a record of the contribution (including all |
||||
personal information I submit with it, including my sign-off) is |
||||
maintained indefinitely and may be redistributed consistent with |
||||
this project or the open source license(s) involved. |
||||
``` |
||||
|
||||
@ -0,0 +1,30 @@
@@ -0,0 +1,30 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?> |
||||
<!-- |
||||
Copyright (c) 2016 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. |
||||
|
||||
--> |
||||
<appendix 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="app_template"> |
||||
<?dbhtml stop-chunking?> |
||||
<title>Appendix template</title> |
||||
<para>This is the first paragraph of a new appendix...</para> |
||||
<section xml:id="sample-app-section"> |
||||
<title>Section title</title> |
||||
<para>Section text...</para> |
||||
</section> |
||||
</appendix> |
||||
@ -0,0 +1,119 @@
@@ -0,0 +1,119 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?> |
||||
<!-- |
||||
Copyright (c) 2016 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>Intrinsic Function 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</year> |
||||
<holder>OpenPOWER Foundation</holder> |
||||
</copyright> |
||||
<!-- TODO: Set the correct document releaseinfo --> |
||||
<releaseinfo>Revision 0.8.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, 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;.</para> |
||||
</abstract> |
||||
|
||||
<revhistory> |
||||
<!-- TODO: Set the initial version information and clear any old information out --> |
||||
<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"/ --> |
||||
<!-- WJS: The ch_outline.xml file is temporary while I work out the rest --> |
||||
<xi:include href="ch_outline.xml"/> |
||||
<xi:include href="ch_vec_reference.xml"/> |
||||
<xi:include href="ch_scal_reference.xml"/> |
||||
<xi:include href="ch_isa_intrin_xref.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> |
||||
@ -0,0 +1,220 @@
@@ -0,0 +1,220 @@
|
||||
<!-- |
||||
Copyright (c) 2016 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. |
||||
|
||||
--> |
||||
<chapter version="5.0" xml:lang="en" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" |
||||
xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="section_template_examples"> |
||||
|
||||
<!-- Chapter Title goes here. --> |
||||
<title>Documentation examples</title> |
||||
|
||||
|
||||
<section> |
||||
<title>Section Title goes here</title> |
||||
<para>This Section covers something of interest to a limited number of people and shows a 1st level section</para> |
||||
|
||||
<section xml:id="list_example_label"> |
||||
<title>Example Itemized List</title> |
||||
<para> |
||||
Here is an example of an itemized list</para> |
||||
<itemizedlist> |
||||
<listitem> |
||||
<para> |
||||
Item you don't care about</para> |
||||
</listitem> |
||||
<listitem> |
||||
<para> |
||||
Item you might care about </para> |
||||
</listitem> |
||||
<listitem> |
||||
<para> |
||||
Item you do care about </para> |
||||
</listitem> |
||||
</itemizedlist> |
||||
</section> |
||||
<section> |
||||
<title>Example ordered list</title> |
||||
<para> |
||||
All good documents need ordered lists.</para> |
||||
<orderedlist> |
||||
<listitem> |
||||
<para>First item</para> |
||||
</listitem> |
||||
<listitem> |
||||
<para>Second item</para> |
||||
<orderedlist numeration="loweralpha"> |
||||
<listitem> |
||||
<para>first indented item</para> |
||||
</listitem> |
||||
<listitem> |
||||
<para> second indented item</para> |
||||
</listitem> |
||||
</orderedlist> |
||||
</listitem> |
||||
<listitem> |
||||
<para>Third item</para> |
||||
</listitem> |
||||
</orderedlist> |
||||
</section> |
||||
|
||||
<section> |
||||
<title>Example figure with embedded graphic</title> |
||||
<para> |
||||
Here is how you embed a graphic.</para> |
||||
<figure pgwide="1" xml:id="figure_label"> |
||||
<title>Example figure</title> |
||||
<mediaobject> |
||||
<imageobject> |
||||
<imagedata fileref="figures/example_graphic.bmp" format="BMP" scalefit="1" width="100%" /> |
||||
</imageobject> |
||||
</mediaobject> |
||||
</figure> |
||||
<note><para>Raw images such as the bitmap (bmp) file above may become blurry as they are scaled. |
||||
Scalable graphic formats like SVG (Scalable Vector Graphics) embed and scale the best.</para></note> |
||||
</section> |
||||
|
||||
<section> |
||||
<title>Example table</title> |
||||
<para>Of course all good documents need tables. Here's how you build a basic table.</para> |
||||
|
||||
<table frame="all" pgwide="1" xml:id="table_label"> |
||||
<title>Example Table Title</title> |
||||
<tgroup cols="4"> |
||||
<colspec colname="c1" colwidth="25*" /> |
||||
<colspec colname="c2" colwidth="25*" /> |
||||
<colspec colname="c3" colwidth="25*" /> |
||||
<colspec colname="c4" colwidth="25*" /> |
||||
<thead> |
||||
<row> |
||||
<entry> |
||||
<para> |
||||
<emphasis role="bold">1st Column Heading</emphasis> |
||||
</para> |
||||
</entry> |
||||
<entry> |
||||
<para> |
||||
<emphasis role="bold">2nd Column Heading</emphasis> |
||||
</para> |
||||
</entry> |
||||
<entry> |
||||
<para> |
||||
<emphasis role="bold">3rd Column Heading</emphasis> |
||||
</para> |
||||
</entry> |
||||
<entry> |
||||
<para> |
||||
<emphasis role="bold">4th Column Heading</emphasis> |
||||
</para> |
||||
</entry> |
||||
</row> |
||||
</thead> |
||||
<tbody> |
||||
<row> |
||||
<entry> |
||||
<para>Yes</para> |
||||
</entry> |
||||
<entry> |
||||
<para><phrase role="red">Red</phrase></para> |
||||
<para><phrase role="green">Green</phrase></para> |
||||
<para><phrase role="blue">Blue</phrase></para> |
||||
<para><phrase role="#FFBF00">Custom (Amber)</phrase></para> |
||||
</entry> |
||||
<entry> |
||||
<para>MAIN_Junk</para> |
||||
</entry> |
||||
<entry> |
||||
<para>More_Junk</para> |
||||
</entry> |
||||
</row> |
||||
<row> |
||||
<entry namest='c1' nameend='c3' align='center'> |
||||
<para>merged cells horizontal</para> |
||||
</entry> |
||||
<entry> |
||||
<para>cell_stuff</para> |
||||
</entry> |
||||
</row> |
||||
<row> |
||||
<entry morerows='1'> |
||||
<para>Merge cells vertical</para> |
||||
</entry> |
||||
<entry> |
||||
<para>filler</para> |
||||
</entry> |
||||
<entry namest='c3' nameend='c4' morerows='1' align='center'> |
||||
<para>merge cells both ways</para> |
||||
</entry> |
||||
</row> |
||||
<row> |
||||
<entry> |
||||
<para>filler 2</para> |
||||
</entry> |
||||
</row> |
||||
<row> |
||||
<entry> |
||||
<para>How about we put a list in the table cell</para> |
||||
<itemizedlist> |
||||
<listitem> |
||||
<para>item 1</para> |
||||
</listitem> |
||||
<listitem> |
||||
<para>item 2</para> |
||||
</listitem> |
||||
<listitem> |
||||
<para>item 2</para> |
||||
</listitem> |
||||
</itemizedlist> |
||||
</entry> |
||||
<entry> |
||||
<para>Another Cell</para> |
||||
</entry> |
||||
<entry> |
||||
<para>Yet Another Cell</para> |
||||
</entry> |
||||
<entry> |
||||
<para>Finally the last cell</para> |
||||
</entry> |
||||
</row> |
||||
</tbody> |
||||
</tgroup> |
||||
</table> |
||||
</section> |
||||
<section> |
||||
<title>Example of crossreferences and footnotes</title> |
||||
<para>To reference another section or table is pretty easy. For example: see <xref linkend="table_label" /> for how tables look.</para> |
||||
<para>Lists are shown in <xref linkend="list_example_label" /> and if you need to make a footnote |
||||
<footnote xml:id="foot_id"><para>The footnote text goes here and can reference something like <xref linkend="figure_label" /> for additional explanation.</para></footnote> |
||||
For clarification that is easy. Of course you might want an additional reference to the footnote <footnoteref linkend="foot_id"/> which can also be done easily.</para> |
||||
<para>Lastly you probably want to mark text by making it <emphasis>italic text example</emphasis> or <emphasis role='bold'>Bold Text Example</emphasis>.</para> |
||||
</section> |
||||
<section> |
||||
<title>Example of code citations and user input</title> |
||||
<para>When showing user input, you want a nice sceen-looking layout, a prompt, monospace text, and a way to differentiate input from output. Here's an example: |
||||
<screen><prompt>$ </prompt><userinput>echo "Hello world"</userinput> |
||||
Hello world |
||||
<prompt>$ </prompt></screen> |
||||
</para> |
||||
<para>Docbook also allows for formatting and display of common languages, allowing for whitespace |
||||
and line returns just as they are written. Here's a sample snippet of C code with line numbering enabled:<programlisting linenumbering="numbered"><![CDATA[#include<stdio.h> |
||||
main() |
||||
{ |
||||
printf("Hello world\n"); |
||||
}]]></programlisting></para> |
||||
<para>If code formatting is not quite what you need, simply displaying text "literally" may suffice as follows: <literal>This is my literal |
||||
text. It ignores whitespace.</literal></para> |
||||
</section> |
||||
|
||||
</section> |
||||
</chapter> |
||||
@ -0,0 +1,26 @@
@@ -0,0 +1,26 @@
|
||||
<!-- |
||||
Copyright (c) 2017 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. |
||||
|
||||
--> |
||||
<chapter version="5.0" xml:lang="en" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" |
||||
xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="section_isa_intrin_xref"> |
||||
|
||||
<!-- Chapter Title goes here. --> |
||||
<title>Instruction/Intrinsic Cross-Reference</title> |
||||
|
||||
<para>This chapter will contain a cross-reference from Power hardware |
||||
instructions to intrinsics that generate them.</para> |
||||
|
||||
</chapter> |
||||
@ -0,0 +1,45 @@
@@ -0,0 +1,45 @@
|
||||
<!-- |
||||
Copyright (c) 2016 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. |
||||
|
||||
--> |
||||
<chapter version="5.0" xml:lang="en" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" |
||||
xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="section_outline"> |
||||
|
||||
<!-- Chapter Title goes here. --> |
||||
<title>Notes on what to include</title> |
||||
|
||||
<itemizedlist spacing="compact"> |
||||
<listitem> |
||||
<para>Rewrite the material from ABI Chapter 6</para> |
||||
</listitem> |
||||
<listitem> |
||||
<para>Recommendations for different ways to create efficient vector |
||||
code |
||||
<itemizedlist spacing="compact"> |
||||
<listitem> |
||||
<para>Portable: C,C++; tricks to help compiler vectorize code</para> |
||||
</listitem> |
||||
<listitem> |
||||
<para>Use intrinsics</para> |
||||
</listitem> |
||||
<listitem> |
||||
<para>Assembly code - not recommended, but if you must</para> |
||||
</listitem> |
||||
</itemizedlist> |
||||
</para> |
||||
</listitem> |
||||
</itemizedlist> |
||||
|
||||
</chapter> |
||||
@ -0,0 +1,31 @@
@@ -0,0 +1,31 @@
|
||||
<!-- |
||||
Copyright (c) 2017 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. |
||||
|
||||
--> |
||||
<chapter version="5.0" xml:lang="en" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" |
||||
xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="section_scal_intrinsics"> |
||||
|
||||
<!-- Chapter Title goes here. --> |
||||
<title>Scalar Intrinsic Reference</title> |
||||
|
||||
<para>Some front matter should go here, describing conventions |
||||
used throughout the chapter.</para> |
||||
|
||||
<section> |
||||
<title>Built-In ((Purpose)) Functions</title> |
||||
<para>Some front matter should go here, describing conventions |
||||
specific to this section.</para> |
||||
</section> |
||||
</chapter> |
||||
@ -0,0 +1,96 @@
@@ -0,0 +1,96 @@
|
||||
<!-- |
||||
Copyright (c) 2016 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. |
||||
|
||||
--> |
||||
<chapter version="5.0" xml:lang="en" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" |
||||
xmlns:xlink="http://www.w3.org/1999/xlink"> |
||||
|
||||
<title>Document development overview</title> |
||||
|
||||
<para>The <emphasis>OpenPOWER Foundation Documentation Development Guide</emphasis> |
||||
provides a framework for OpenPOWER public and private |
||||
documentation. The goal of the template and this writeup is to promote community contributions |
||||
to OpenPOWER documenation and to enable new contributions within a common look and feel. </para> |
||||
|
||||
<para>The major sections of this document addresses the following topics:</para> |
||||
<itemizedlist> |
||||
<listitem> |
||||
<para><xref linkend="section_template_getting_started" endterm="section_template_getting_started_title"/>: |
||||
This section details tools and commands used to contribute to OpenPOWER documentation. |
||||
All users who are new to OpenPOWER Foundation documentation should start here.</para> |
||||
</listitem> |
||||
<listitem> |
||||
<para><xref linkend="section_template_new_document" endterm="section_template_new_document_title"/>: |
||||
This section provides step-by-step instructions on how to create a new document |
||||
from scratch. Use this section to start a new document.</para> |
||||
</listitem> |
||||
<listitem> |
||||
<para><xref linkend="section_template_existing_document" endterm="section_template_existing_document_title"/>: |
||||
This section highlights common steps in editing an existing OpenPOWER |
||||
Foundation document. Use this section as a guideline for contributing to an existing document.</para> |
||||
</listitem> |
||||
<listitem> |
||||
<para><xref linkend="section_template_debug" endterm="section_template_debug_title"/>: |
||||
This section provides examples of the two most common types of build failures |
||||
and helps users find the relevant failure information.</para> |
||||
</listitem> |
||||
<listitem> |
||||
<para><xref linkend="section_template_process" endterm="section_template_process_title"/>: |
||||
This section explains key document types and the appropriate work flow for publishing OpenPOWER Foundation |
||||
documents.</para> |
||||
</listitem> |
||||
<listitem> |
||||
<para><xref linkend="section_template_structure" endterm="section_template_structure_title"/>: |
||||
This section provides detailed descriptions of the various project |
||||
components and their roles in the documentation creation process.</para> |
||||
</listitem> |
||||
<listitem> |
||||
<para><xref linkend="section_template_policies" endterm="section_template_policies_title"/>: This section contains |
||||
the generally accepted guidelines for creating OpenPOWER documentation. Use this section as a reference |
||||
for documentation style beyond template provided features.</para> |
||||
</listitem> |
||||
<listitem> |
||||
<para><xref linkend="section_template_faq" endterm="section_template_faq_title"/>: |
||||
This section answers common questions. Use this section when the other sections |
||||
do not answer your questions.</para> |
||||
</listitem> |
||||
<listitem> |
||||
<para><xref linkend="section_template_git_commands" endterm="section_template_git_commands_title"/>: |
||||
This section contains examples of commonly used git commands. Reference this section |
||||
to find information on a specific git operation.</para> |
||||
</listitem> |
||||
<listitem> |
||||
<para><xref linkend="section_template_references" endterm="section_template_references_title"/>: |
||||
This section provides pointers to on-line information about XML, Docbook, |
||||
Maven, and other relevant references.</para> |
||||
</listitem> |
||||
</itemizedlist> |
||||
|
||||
<para>In addition to OpenPOWER Foundation specific topics, <xref linkend="section_template_examples"/> |
||||
provides examples of common documenation constructs in XML.</para> |
||||
|
||||
<xi:include href="sec_template_getting_started.xml"/> |
||||
<xi:include href="sec_template_new_document.xml"/> |
||||
<xi:include href="sec_template_existing_document.xml"/> |
||||
<xi:include href="sec_template_debugging.xml"/> |
||||
<xi:include href="sec_template_process.xml"/> |
||||
<xi:include href="sec_template_structure.xml"/> |
||||
<xi:include href="sec_template_policies.xml"/> |
||||
<xi:include href="sec_template_faq.xml"/> |
||||
<xi:include href="sec_template_git_commands.xml"/> |
||||
<xi:include href="sec_template_references.xml"/> |
||||
|
||||
|
||||
</chapter> |
||||
File diff suppressed because it is too large
Load Diff
|
After Width: | Height: | Size: 648 KiB |
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 24 KiB |
Binary file not shown.
