Skip to content

Commit

Permalink
Update readme with information about C++ for OpenCL. (#587)
Browse files Browse the repository at this point in the history
Co-authored-by: Sven van Haastregt <sven.vanhaastregt@arm.com>
  • Loading branch information
AnastasiaStulova and svenvh authored Mar 29, 2021
1 parent 8b57306 commit 72e3659
Showing 1 changed file with 44 additions and 37 deletions.
81 changes: 44 additions & 37 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ Dependencies>>.

This repository contains the source and tool chain used to generate the
formal OpenCL API, OpenCL Extensions, OpenCL SPIR-V Environment, and
OpenCL C++ Specifications, as well as the OpenCL 2.2 Reference Pages.
OpenCL C++ Specifications, as well as the OpenCL 2.2 Reference Pages
and documentation for the C++ for OpenCL kernel language.

This file describes the repository structure, tools, and build instructions
needed.
Expand Down Expand Up @@ -43,21 +44,23 @@ We intend to maintain a linear history on the GitHub `master` branch.
== Repository Structure

|====
| *File* | *Description*
| `README.adoc` | This file
| `Makefile` | GNU Makefile used to build HTML and PDF spec targets
| `config/` | Support files for asciidoctor build, HTML CSS / Javascript, etc.
| `katex/` | KaTeX math renderer for HTML outputs
| `OpenCL_API.txt` | Main source file for the OpenCL API Specification
| `api/` | Individual sections of the API Specification
| `OpenCL_Cxx.txt` | Main source file for the OpenCL C++ Specification
| `cxx/` | Individual sections of the C++ Specification
| `OpenCL_Env.txt` | Main source file for the OpenCL SPIR-V Environment Specification
| `env/` | Individual sections of the Environment Specification
| `OpenCL_Ext.txt` | Main source file for the OpenCL Extensions Specification
| `ext/` | Individual sections of the Extensions Specification
| `images/` | Shared images, used by all specs
| `man/` | Static reference page sources
| *File* | *Description*
| `README.adoc` | This file
| `Makefile` | GNU Makefile used to build HTML and PDF spec targets
| `config/` | Support files for asciidoctor build, HTML CSS / Javascript, etc.
| `katex/` | KaTeX math renderer for HTML outputs
| `OpenCL_API.txt` | Main source file for the OpenCL API Specification
| `api/` | Individual sections of the API Specification
| `OpenCL_Cxx.txt` | Main source file for the OpenCL C++ Specification
| `cxx/` | Individual sections of the C++ Specification
| `OpenCL_Env.txt` | Main source file for the OpenCL SPIR-V Environment Specification
| `env/` | Individual sections of the Environment Specification
| `OpenCL_Ext.txt` | Main source file for the OpenCL Extensions Specification
| `ext/` | Individual sections of the Extensions Specification
| `CXX_for_OpenCL.txt` | Main source file for the C++ for OpenCL Documentation
| `cxx4opencl/` | Individual sections of the C++ for OpenCL Documentation
| `images/` | Shared images, used by all specs
| `man/` | Static reference page sources
|====


Expand All @@ -73,27 +76,31 @@ Other Makefile targets are available for building the different outputs
for each Specification:

|====
| *Target* | *Builds*
| html | HTML outputs for all specifications
| pdf | PDF outputs for all specifications
| |
| api | HTML and PDF outputs for API Specification
| apihtml | HTML outputs for API Specification
| apipdf | PDF outputs for API Specification
| |
| cxx | HTML and PDF outputs for C++ Specification
| cxxhtml | HTML outputs for C++ Specification
| cxxpdf | PDF outputs for C++ Specification
| |
| env | HTML and PDF outputs for SPIR-V Environment Specification
| envhtml | HTML outputs for Environment Specification
| envpdf | PDF outputs for Environment Specification
| |
| ext | HTML and PDF outputs for Extensions Specification
| exthtml | HTML outputs for Extensions Specification
| extpdf | PDF outputs for Extensions Specification
| |
| manhtmlpages | HTML outputs for Reference Pages
| *Target* | *Builds*
| html | HTML outputs for all specifications
| pdf | PDF outputs for all specifications
| |
| api | HTML and PDF outputs for API Specification
| apihtml | HTML outputs for API Specification
| apipdf | PDF outputs for API Specification
| |
| cxx | HTML and PDF outputs for C++ Specification
| cxxhtml | HTML outputs for C++ Specification
| cxxpdf | PDF outputs for C++ Specification
| |
| env | HTML and PDF outputs for SPIR-V Environment Specification
| envhtml | HTML outputs for Environment Specification
| envpdf | PDF outputs for Environment Specification
| |
| ext | HTML and PDF outputs for Extensions Specification
| exthtml | HTML outputs for Extensions Specification
| extpdf | PDF outputs for Extensions Specification
| |
| cxx4opencl | HTML and PDF outputs for C++ for OpenCL Documentation
| cxx4openclhtml | HTML outputs for C++ for OpenCL Documentation
| cxx4openclpdf | PDF outputs for C++ for OpenCL Documentation
| |
| manhtmlpages | HTML outputs for Reference Pages
|====

The specification targets are generated in `out/html/` for HTML targets,
Expand Down

0 comments on commit 72e3659

Please sign in to comment.