Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add compatibility notes #238

Merged
merged 3 commits into from
Sep 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion .github/workflows/linux.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
name: Linux

on: [push, pull_request]
on:
push:
paths-ignore:
- '**/*.md'
pull_request:
paths-ignore:
- '**/*.md'

jobs:
compatibility:
Expand Down
8 changes: 7 additions & 1 deletion .github/workflows/macos.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
name: MacOS

on: [push, pull_request]
on:
push:
paths-ignore:
- '**/*.md'
pull_request:
paths-ignore:
- '**/*.md'

jobs:
compatibility:
Expand Down
8 changes: 7 additions & 1 deletion .github/workflows/windows.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
name: Windows

on: [push, pull_request]
on:
push:
paths-ignore:
- '**/*.md'
pull_request:
paths-ignore:
- '**/*.md'

jobs:
compatibility:
Expand Down
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,23 @@ may include the OpenCL API headers as follows:
#include <CL/opencl.h>
```

## Compatibility Notes

OpenCL values backward compatibility and in most cases an application using an
older version of the OpenCL API headers can seamlessly update to a newer version
of the OpenCL API headers. In rare cases, though, the OpenCL API headers may
break backward compatibility:

* Very rarely, there may be bugs or other issues in the OpenCL API headers that
cannot be fixed without breaking compatibility.
* The OpenCL API headers for provisional features or provisional extensions may
be changed in a way that breaks compatibility.

Applications or libraries that require stable OpenCL API headers are encouraged
to use tagged or released OpenCL API headers. We will do our best to document
any breaking changes in the description of each release. The OpenCL API headers
are tagged at least as often as each OpenCL specification release.

## Directory Structure

```
Expand Down
Loading