summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.github/workflows/linux.yml8
-rw-r--r--.github/workflows/macos.yml8
-rw-r--r--.github/workflows/windows.yml8
-rw-r--r--README.md17
4 files changed, 38 insertions, 3 deletions
diff --git a/.github/workflows/linux.yml b/.github/workflows/linux.yml
index 9c1733b..3db0d2c 100644
--- a/.github/workflows/linux.yml
+++ b/.github/workflows/linux.yml
@@ -1,6 +1,12 @@
name: Linux
-on: [push, pull_request]
+on:
+ push:
+ paths-ignore:
+ - '**/*.md'
+ pull_request:
+ paths-ignore:
+ - '**/*.md'
jobs:
compatibility:
diff --git a/.github/workflows/macos.yml b/.github/workflows/macos.yml
index fa79034..c1b2972 100644
--- a/.github/workflows/macos.yml
+++ b/.github/workflows/macos.yml
@@ -1,6 +1,12 @@
name: MacOS
-on: [push, pull_request]
+on:
+ push:
+ paths-ignore:
+ - '**/*.md'
+ pull_request:
+ paths-ignore:
+ - '**/*.md'
jobs:
compatibility:
diff --git a/.github/workflows/windows.yml b/.github/workflows/windows.yml
index 25be863..4def21d 100644
--- a/.github/workflows/windows.yml
+++ b/.github/workflows/windows.yml
@@ -1,6 +1,12 @@
name: Windows
-on: [push, pull_request]
+on:
+ push:
+ paths-ignore:
+ - '**/*.md'
+ pull_request:
+ paths-ignore:
+ - '**/*.md'
jobs:
compatibility:
diff --git a/README.md b/README.md
index 89a3ea9..1a49189 100644
--- a/README.md
+++ b/README.md
@@ -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
```