@@ -15,7 +15,8 @@ Dependencies>>.
1515
1616This repository contains the source and tool chain used to generate the
1717formal OpenCL API, OpenCL Extensions, OpenCL SPIR-V Environment, and
18- OpenCL C++ Specifications, as well as the OpenCL 2.2 Reference Pages.
18+ OpenCL C++ Specifications, as well as the OpenCL 2.2 Reference Pages
19+ and documentation for the C++ for OpenCL kernel language.
1920
2021This file describes the repository structure, tools, and build instructions
2122needed.
@@ -43,21 +44,23 @@ We intend to maintain a linear history on the GitHub `master` branch.
4344== Repository Structure
4445
4546|====
46- | *File* | *Description*
47- | `README.adoc` | This file
48- | `Makefile` | GNU Makefile used to build HTML and PDF spec targets
49- | `config/` | Support files for asciidoctor build, HTML CSS / Javascript, etc.
50- | `katex/` | KaTeX math renderer for HTML outputs
51- | `OpenCL_API.txt` | Main source file for the OpenCL API Specification
52- | `api/` | Individual sections of the API Specification
53- | `OpenCL_Cxx.txt` | Main source file for the OpenCL C++ Specification
54- | `cxx/` | Individual sections of the C++ Specification
55- | `OpenCL_Env.txt` | Main source file for the OpenCL SPIR-V Environment Specification
56- | `env/` | Individual sections of the Environment Specification
57- | `OpenCL_Ext.txt` | Main source file for the OpenCL Extensions Specification
58- | `ext/` | Individual sections of the Extensions Specification
59- | `images/` | Shared images, used by all specs
60- | `man/` | Static reference page sources
47+ | *File* | *Description*
48+ | `README.adoc` | This file
49+ | `Makefile` | GNU Makefile used to build HTML and PDF spec targets
50+ | `config/` | Support files for asciidoctor build, HTML CSS / Javascript, etc.
51+ | `katex/` | KaTeX math renderer for HTML outputs
52+ | `OpenCL_API.txt` | Main source file for the OpenCL API Specification
53+ | `api/` | Individual sections of the API Specification
54+ | `OpenCL_Cxx.txt` | Main source file for the OpenCL C++ Specification
55+ | `cxx/` | Individual sections of the C++ Specification
56+ | `OpenCL_Env.txt` | Main source file for the OpenCL SPIR-V Environment Specification
57+ | `env/` | Individual sections of the Environment Specification
58+ | `OpenCL_Ext.txt` | Main source file for the OpenCL Extensions Specification
59+ | `ext/` | Individual sections of the Extensions Specification
60+ | `CXX_for_OpenCL.txt` | Main source file for the C++ for OpenCL Documentation
61+ | `cxx4opencl/` | Individual sections of the C++ for OpenCL Documentation
62+ | `images/` | Shared images, used by all specs
63+ | `man/` | Static reference page sources
6164|====
6265
6366
@@ -73,27 +76,31 @@ Other Makefile targets are available for building the different outputs
7376for each Specification:
7477
7578|====
76- | *Target* | *Builds*
77- | html | HTML outputs for all specifications
78- | pdf | PDF outputs for all specifications
79- | |
80- | api | HTML and PDF outputs for API Specification
81- | apihtml | HTML outputs for API Specification
82- | apipdf | PDF outputs for API Specification
83- | |
84- | cxx | HTML and PDF outputs for C++ Specification
85- | cxxhtml | HTML outputs for C++ Specification
86- | cxxpdf | PDF outputs for C++ Specification
87- | |
88- | env | HTML and PDF outputs for SPIR-V Environment Specification
89- | envhtml | HTML outputs for Environment Specification
90- | envpdf | PDF outputs for Environment Specification
91- | |
92- | ext | HTML and PDF outputs for Extensions Specification
93- | exthtml | HTML outputs for Extensions Specification
94- | extpdf | PDF outputs for Extensions Specification
95- | |
96- | manhtmlpages | HTML outputs for Reference Pages
79+ | *Target* | *Builds*
80+ | html | HTML outputs for all specifications
81+ | pdf | PDF outputs for all specifications
82+ | |
83+ | api | HTML and PDF outputs for API Specification
84+ | apihtml | HTML outputs for API Specification
85+ | apipdf | PDF outputs for API Specification
86+ | |
87+ | cxx | HTML and PDF outputs for C++ Specification
88+ | cxxhtml | HTML outputs for C++ Specification
89+ | cxxpdf | PDF outputs for C++ Specification
90+ | |
91+ | env | HTML and PDF outputs for SPIR-V Environment Specification
92+ | envhtml | HTML outputs for Environment Specification
93+ | envpdf | PDF outputs for Environment Specification
94+ | |
95+ | ext | HTML and PDF outputs for Extensions Specification
96+ | exthtml | HTML outputs for Extensions Specification
97+ | extpdf | PDF outputs for Extensions Specification
98+ | |
99+ | cxx4opencl | HTML and PDF outputs for C++ for OpenCL Documentation
100+ | cxx4openclhtml | HTML outputs for C++ for OpenCL Documentation
101+ | cxx4openclpdf | PDF outputs for C++ for OpenCL Documentation
102+ | |
103+ | manhtmlpages | HTML outputs for Reference Pages
97104|====
98105
99106The specification targets are generated in `out/html/` for HTML targets,
0 commit comments