PDA

View Full Version : OpenCL man page sources available in public Subversion



oddhack
04-12-2010, 03:59 PM
Khronos has released the OpenCL 1.0 man page XML sources. They are under the Khronos Free Use License (BSD-like) so people can modify, repackage, redistribute etc.

You will need to have a reasonable understanding of Subversion, Docbook, XML, XSLT, Linux package management (if using Linux), and other components of the toolchain used to generate the man pages, before you're likely to have much success with them. A great deal of Docbook, XML, and XSL infrastructure may need to be installed on your system first.

The directory tree containing the man pages is available for anonymous, read-only checkout in Khronos' Subversion server, at

https://cvs.khronos.org/svn/repos/regis ... /docs/man/ (https://cvs.khronos.org/svn/repos/registry/trunk/public/cl/sdk/1.0/docs/man/)

If you have the Subversion command-line client installed, you should be able to check out the man pages into the directory 'man' by executing the command


svn co --username anonymous --password anonymous https://cvs.khronos.org/svn/repos/registry/trunk/public/cl/sdk/1.0/docs/man/ man

Under 'man' you'll find the OpenCL 1.0 man pages, both the Docbook XML source in this directory and generated XHTML+MathML in xhtml/ , and some supporting build and XSL infrastructure.

There are two pages in the OpenGL.org Wiki containing additional documentation; these pages talk about the OpenGL man page sources, but the OpenCL man pages use much the same Docbook toolchain so this will at least give you some guidance on the Docbook, XML, XSLT, etc. packages you'll need to install. Eventually I hope to update these to cover OpenCL specifically as well.

http://www.opengl.org/wiki/Getting_star ... _Man_Pages (http://www.opengl.org/wiki/Getting_started/XML_Toolchain_and_Man_Pages)
- Description of the tools used to build the man pages; how to install and make use of them if you want to build them yourself; and how to report problems.

http://www.opengl.org/wiki/Getting_star ... and_MathML (http://www.opengl.org/wiki/Getting_started/Viewing_XHTML_and_MathML)
- Some notes on viewing XHTML+MathML documents in different browsers.

Gedolo
04-14-2010, 08:11 AM
This is a great resource for experienced users.

Could you guys please don't use docBook and find something else.
It has a few very dark sides hidden in it's format.

krzysztofl
04-23-2010, 03:00 AM
While working with the OpenCL 1.0 man page XML sources you provided I noticed an inconsistency with the OpenCL Specification file (version 1.0, revision:48).

The problem is with vloada_halfn_* functions.
In XML sources (https://cvs.khronos.org/svn/repos/registry/trunk/public/cl/sdk/1.0/docs/man/xhtml/vloada_halfn.html) there are 3 function definitions which don't exist in the specification (http://www.khronos.org/registry/cl/specs/opencl-1.x-latest.pdf#page=186).
These functions are listed below:
- floatn vloada_halfn_rte ( size_t offset, __local half *p)
- floatn vloada_halfn_rtz ( size_t offset, __constant half *p)
- floatn vloada_halfn_rtp ( size_t offset, __private half *p)

Please clarify the inconsistency.

oddhack
08-25-2011, 01:04 PM
I want to know if it is only for experienced users.

The man pages are a reference guide but they are not a tutorial, so they are likely to be most useful to people who already know OpenCL at a high level, but want to remind themselves of details of how particular functions work.

mbien
08-31-2011, 09:12 AM
imageFunctions.xml has a bug in the DOCTYPE declaration
https://cvs.khronos.org/svn/repos/regis ... ctions.xml (https://cvs.khronos.org/svn/repos/registry/trunk/public/cl/sdk/1.1/docs/man/imageFunctions.xml)


XML Parsing Error: syntax error
Location: https://cvs.khronos.org/svn/repos/registry/trunk/public/cl/sdk/1.1/docs/man/imageFunctions.xml
Line Number 3, Column 82: "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">[
-----------------------------------------------------------------------------------------------------^

looks like a typo, commonFunctions.xml for example does it right.

bwatt
08-31-2011, 05:19 PM
File a bugzilla please.

david.garcia
08-31-2011, 05:26 PM
Link: http://www.khronos.org/bugzilla

mbien
08-31-2011, 06:07 PM
done

oddhack
09-01-2011, 04:12 AM
imageFunctions.xml has a bug in the DOCTYPE declaration
...
looks like a typo, commonFunctions.xml for example does it right.

This has been fixed, thanks.

Danny555
12-13-2012, 03:25 AM
Its good because it is a a very usefull source for experienced users.