From 926eeaaefd2a56669149448d20cb7a022edb2ca6 Mon Sep 17 00:00:00 2001 From: Nikhil Joshi Date: Tue, 18 Jun 2019 16:40:56 +0530 Subject: [PATCH 1/2] WIP: Add CONTRIBUTING.md and explain version increment Add CONTRIBUTING.md to explain 1. How to contribute to OpenCL ICD Loader project. 2. ICD loader versioning guidelines including when to increment the version number. --- CONTRIBUTING.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..d2a840e4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,26 @@ +# Contributing to the OpenCL ICD Loader project. + +Contributions to the OpenCL ICD Loader are welcomed and encouraged. +Please follow the instructions below for submitting your patches. + +## Preparing and submitting changes + +Please propose changes to the ICD loader using GitHub pull requests. +You will be prompted with a one-time "click-through" CLA dialog as part of submitting your pull request or other contribution to GitHub. + +## Windows DLL versioning + +The ICD Loader version is maintained in `loader/windows/OpenCL.rc` in the form `x.y.z.0` in three fields: +FILEVERSION, PRODUCTVERSION and FileVersion. + +The `z` component of the version must be incremented by one for each pull request that modifies anything in the `loader` directory. +The fields must match each other after the increment. + +## Linux shared library versioning + +The ICD loader library version on Linux is 1.2 with SONAME set to libOpenCL.so.1 using the SOVERSION property in CMakeLists.txt. +This version does not change when new API functions are added to the ICD loader because the loader maintains backwards compatibility. +Note that the version number is independent of the OpenCL specification revision number. + +No changes are required in the library version when submitting pull requests. + From 70fe7c689fab0941b2af55acdc99af1d928f1052 Mon Sep 17 00:00:00 2001 From: Nikhil Joshi Date: Tue, 23 Jul 2019 21:39:27 +0530 Subject: [PATCH 2/2] Update CONTRIBUTING.md for Linux ICD loader version Add instructions to increment RELEASE field of linux ICD loader library version. --- CONTRIBUTING.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d2a840e4..ad443221 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,8 +19,9 @@ The fields must match each other after the increment. ## Linux shared library versioning The ICD loader library version on Linux is 1.2 with SONAME set to libOpenCL.so.1 using the SOVERSION property in CMakeLists.txt. -This version does not change when new API functions are added to the ICD loader because the loader maintains backwards compatibility. +MAJOR version does not change when new API functions are added to the ICD loader because the loader maintains backwards compatibility. +MINOR version remains 2. Note that the version number is independent of the OpenCL specification revision number. - -No changes are required in the library version when submitting pull requests. +ICD loader library version should take the form MAJOR.MINOR.RELEASE instead of currently used MAJOR.MINOR format (e.g. current version 1.2 should become 1.2.0). +RELEASE field should be incremented by one for each pull request that modifies anything in the loader directory.