Results 1 to 10 of 10

Thread: OpenCL man page sources available in public Subversion

  1. #1
    Member
    Join Date
    Sep 2003
    Location
    Silicon Valley
    Posts
    57

    OpenCL man page sources available in public Subversion

    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/

    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

    Code :
    svn co --username anonymous --password anonymous [url]https://cvs.khronos.org/svn/repos/registry/trunk/public/cl/sdk/1.0/docs/man/[/url] 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
    - 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
    - Some notes on viewing XHTML+MathML documents in different browsers.
    Jon Leech
    EGL & OpenGL Specification Editor / OpenGL ARB Ecosystem TSG Chair / Khronos API Registrar

  2. #2

    Re: OpenCL man page sources available in public Subversion

    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.

  3. #3
    Junior Member
    Join Date
    Apr 2010
    Posts
    1

    Re: OpenCL man page sources available in public Subversion

    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:4.

    The problem is with vloada_halfn_* functions.
    In XML sources (https://cvs.khronos.org/svn/repos/re...ada_halfn.html) there are 3 function definitions which don't exist in the specification (http://www.khronos.org/registry/cl/s...t.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.

  4. #4
    Member
    Join Date
    Sep 2003
    Location
    Silicon Valley
    Posts
    57

    Re: OpenCL man page sources available in public Subversion

    Quote Originally Posted by DaisyZiete
    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.
    Jon Leech
    EGL & OpenGL Specification Editor / OpenGL ARB Ecosystem TSG Chair / Khronos API Registrar

  5. #5
    Junior Member
    Join Date
    Mar 2011
    Posts
    4

    Re: OpenCL man page sources available in public Subversion

    imageFunctions.xml has a bug in the DOCTYPE declaration
    https://cvs.khronos.org/svn/repos/regis ... ctions.xml
    Code :
    XML Parsing Error: syntax error
    Location: [url]https://cvs.khronos.org/svn/repos/registry/trunk/public/cl/sdk/1.1/docs/man/imageFunctions.xml[/url]
    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.

  6. #6

    Re: OpenCL man page sources available in public Subversion

    File a bugzilla please.

  7. #7
    Senior Member
    Join Date
    May 2010
    Location
    Toronto, Canada
    Posts
    845

    Re: OpenCL man page sources available in public Subversion

    Disclaimer: Employee of Qualcomm Canada. Any opinions expressed here are personal and do not necessarily reflect the views of my employer. LinkedIn profile.

  8. #8
    Junior Member
    Join Date
    Mar 2011
    Posts
    4

    Re: OpenCL man page sources available in public Subversion

    done

  9. #9
    Member
    Join Date
    Sep 2003
    Location
    Silicon Valley
    Posts
    57

    Re: OpenCL man page sources available in public Subversion

    Quote Originally Posted by mbien
    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.
    Jon Leech
    EGL & OpenGL Specification Editor / OpenGL ARB Ecosystem TSG Chair / Khronos API Registrar

  10. #10
    Junior Member
    Join Date
    Dec 2012
    Posts
    1

    Re: OpenCL man page sources available in public Subversion

    Its good because it is a a very usefull source for experienced users.

Similar Threads

  1. Public extensions and add-ons on github
    By VincentH in forum Suggestions for next release
    Replies: 0
    Last Post: 11-01-2012, 01:21 PM
  2. opencl sources of zlib..
    By phoebe0105 in forum OpenCL
    Replies: 1
    Last Post: 04-22-2010, 04:48 AM

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •