Add proper license IDs to all .rst doc files and others

All doc files should use CC-BY-4.0, and sources should use BSD-3-CLAUSE. This commit adds parseable SPDX-LICENSE-IDENTIFIER tags to all `.rst` files and some others identified during a recent license scan by ASWF. Signed-off-by: Gary Oberbrunner <[email protected]>
AcademySoftwareFoundation · Aug 29, 2024 · 78a927e · 78a927e
1 parent a98b77b
commit 78a927e
Show file tree

Hide file tree

Showing 57 changed files with 97 additions and 9 deletions.
diff --git a/Documentation/genPropertiesReference.py b/Documentation/genPropertiesReference.py
@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: BSD-3-Clause
+
 import os,sys, getopt,re
 
 badlyNamedProperties = ["kOfxImageEffectFrameVarying", "kOfxImageEffectPluginRenderThreadSafety"]

diff --git a/Documentation/sources/Guide/index.rst b/Documentation/sources/Guide/index.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 OpenFX Programming Guide
 ========================
 

diff --git a/Documentation/sources/Guide/ofxExample1_Basics.rst b/Documentation/sources/Guide/ofxExample1_Basics.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _basicExample:
 
 This is a guide to the basic machinery an OFX plugin uses to communicate

diff --git a/Documentation/sources/Guide/ofxExample2_Invert.rst b/Documentation/sources/Guide/ofxExample2_Invert.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _invertExample:
 
 This guide will take you through the fundamentals of processing images

diff --git a/Documentation/sources/Guide/ofxExample3_Gain.rst b/Documentation/sources/Guide/ofxExample3_Gain.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _gainExample:
 
 This guide will take you through the basics of creating and using

diff --git a/Documentation/sources/Guide/ofxExample4_Saturation.rst b/Documentation/sources/Guide/ofxExample4_Saturation.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _saturationExample:
 
 This guide will take you through the basics of creating effects that can

diff --git a/Documentation/sources/Guide/ofxExample5_Circle.rst b/Documentation/sources/Guide/ofxExample5_Circle.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _circleExample:
 
 This guide will introduce the spatial coordinate system used by OFX and

diff --git a/Documentation/sources/Guide/ofxExamples.rst b/Documentation/sources/Guide/ofxExamples.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 Foreword
 ========
 

diff --git a/Documentation/sources/Reference/DoxygenIndex.rst b/Documentation/sources/Reference/DoxygenIndex.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _doxygenIndex:
 
 ==============================

diff --git a/Documentation/sources/Reference/apiChanges_1_2_Chapter.rst b/Documentation/sources/Reference/apiChanges_1_2_Chapter.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 Changes to the API for 1.2
 ==========================
 

diff --git a/Documentation/sources/Reference/index.rst b/Documentation/sources/Reference/index.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 OpenFX reference
 ================
 

diff --git a/Documentation/sources/Reference/ofxClipPreferences.rst b/Documentation/sources/Reference/ofxClipPreferences.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _ImageEffectClipPreferences:
 
 Image Effect Clip Preferences

diff --git a/Documentation/sources/Reference/ofxCoordSystem.rst b/Documentation/sources/Reference/ofxCoordSystem.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. CoordinateSystems:
 Coordinate Systems
 ==================

diff --git a/Documentation/sources/Reference/ofxCoreAPI.rst b/Documentation/sources/Reference/ofxCoreAPI.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 The Generic Core API
 ====================
 

diff --git a/Documentation/sources/Reference/ofxHostStruct.rst b/Documentation/sources/Reference/ofxHostStruct.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxHost:
 
 The OfxHost Struct
@@ -32,4 +33,4 @@ suite, or NULL if it does not support it. Please note that a suite
 cannot be fetched until the very first action is called on the plug-in,
 which is the load action.
 
-.. doxygenstruct:: OfxHost
+.. doxygenstruct:: OfxHost
diff --git a/Documentation/sources/Reference/ofxImageClip.rst b/Documentation/sources/Reference/ofxImageClip.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _imageClip:
 Images and Clips
 ================

diff --git a/Documentation/sources/Reference/ofxImageEffectAPI.rst b/Documentation/sources/Reference/ofxImageEffectAPI.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 The Image Effect API
 ====================
 

diff --git a/Documentation/sources/Reference/ofxImageEffectActions.rst b/Documentation/sources/Reference/ofxImageEffectActions.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _ImageEffectActions:
 
 Actions Passed to An Image Effect

diff --git a/Documentation/sources/Reference/ofxImageEffectContexts.rst b/Documentation/sources/Reference/ofxImageEffectContexts.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _imageEffectContexts:
 Image Effect Contexts
 =====================

diff --git a/Documentation/sources/Reference/ofxInteractActions.rst b/Documentation/sources/Reference/ofxInteractActions.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. InteractActions:
 
 Actions Passed to an Interact

diff --git a/Documentation/sources/Reference/ofxInteracts.rst b/Documentation/sources/Reference/ofxInteracts.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 Interacts
 =========
 

diff --git a/Documentation/sources/Reference/ofxLoadingSequence.rst b/Documentation/sources/Reference/ofxLoadingSequence.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 Sequences of Operations Required to Load a Plug-in
 ---------------------------------------------------
 

diff --git a/Documentation/sources/Reference/ofxPackaging.rst b/Documentation/sources/Reference/ofxPackaging.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 Packaging OFX Plug-ins
 ======================
 

diff --git a/Documentation/sources/Reference/ofxParameter.rst b/Documentation/sources/Reference/ofxParameter.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 Effect Parameters
 =================
 

diff --git a/Documentation/sources/Reference/ofxPluginStruct.rst b/Documentation/sources/Reference/ofxPluginStruct.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxPlugin:
 
 The OfxPlugin Struct

diff --git a/Documentation/sources/Reference/ofxProcessingArch.rst b/Documentation/sources/Reference/ofxProcessingArch.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 Image Processing Architectures
 ==============================
 

diff --git a/Documentation/sources/Reference/ofxPropertiesByObject.rst b/Documentation/sources/Reference/ofxPropertiesByObject.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. warning::
 
     This section is outdated and should be properly generated automatically from source code instead

diff --git a/Documentation/sources/Reference/ofxPropertiesReference.rst b/Documentation/sources/Reference/ofxPropertiesReference.rst
@@ -1,6 +1,8 @@
 .. _propertiesReference:
 Properties Reference
 =====================
+.. doxygendefine:: kOfxImageClipPropColourspace
+
 .. doxygendefine:: kOfxImageClipPropConnected
 
 .. doxygendefine:: kOfxImageClipPropContinuousSamples
@@ -13,6 +15,8 @@ Properties Reference
 
 .. doxygendefine:: kOfxImageClipPropOptional
 
+.. doxygendefine:: kOfxImageClipPropPreferredColourspaces
+
 .. doxygendefine:: kOfxImageClipPropUnmappedComponents
 
 .. doxygendefine:: kOfxImageClipPropUnmappedPixelDepth
@@ -41,6 +45,22 @@ Properties Reference
 
 .. doxygendefine:: kOfxImageEffectPropClipPreferencesSlaveParam
 
+.. doxygendefine:: kOfxImageEffectPropColourManagementAvailableConfigs
+
+.. doxygendefine:: kOfxImageEffectPropColourManagementBasic
+
+.. doxygendefine:: kOfxImageEffectPropColourManagementConfig
+
+.. doxygendefine:: kOfxImageEffectPropColourManagementCore
+
+.. doxygendefine:: kOfxImageEffectPropColourManagementFull
+
+.. doxygendefine:: kOfxImageEffectPropColourManagementNone
+
+.. doxygendefine:: kOfxImageEffectPropColourManagementOCIO
+
+.. doxygendefine:: kOfxImageEffectPropColourManagementStyle
+
 .. doxygendefine:: kOfxImageEffectPropComponents
 
 .. doxygendefine:: kOfxImageEffectPropContext
@@ -53,6 +73,8 @@ Properties Reference
 
 .. doxygendefine:: kOfxImageEffectPropCudaStreamSupported
 
+.. doxygendefine:: kOfxImageEffectPropDisplayColourspace
+
 .. doxygendefine:: kOfxImageEffectPropFieldToRender
 
 .. doxygendefine:: kOfxImageEffectPropFrameRange
@@ -71,6 +93,12 @@ Properties Reference
 
 .. doxygendefine:: kOfxImageEffectPropMetalRenderSupported
 
+.. doxygendefine:: kOfxImageEffectPropOCIOConfig
+
+.. doxygendefine:: kOfxImageEffectPropOCIODisplay
+
+.. doxygendefine:: kOfxImageEffectPropOCIOView
+
 .. doxygendefine:: kOfxImageEffectPropOpenCLCommandQueue
 
 .. doxygendefine:: kOfxImageEffectPropOpenCLEnabled

diff --git a/Documentation/sources/Reference/ofxRendering.rst b/Documentation/sources/Reference/ofxRendering.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 Rendering
 =========
 

diff --git a/Documentation/sources/Reference/ofxStatusCodes.rst b/Documentation/sources/Reference/ofxStatusCodes.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _statusCodes:
 
 Status Codes

diff --git a/Documentation/sources/Reference/ofxStructure.rst b/Documentation/sources/Reference/ofxStructure.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 Structure of The OFX and the Image Effect API
 =============================================
 

diff --git a/Documentation/sources/Reference/ofxThreadSafety.rst b/Documentation/sources/Reference/ofxThreadSafety.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _threadRecursionSafety:
 Thread and Recursion Safety
 ===========================

diff --git a/Documentation/sources/Reference/suites/ofxDrawSuiteReference.rst b/Documentation/sources/Reference/suites/ofxDrawSuiteReference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxDrawSuiteV1:
 OfxDrawSuiteV1: Drawing Overlays
 ================================

diff --git a/Documentation/sources/Reference/suites/ofxImageEffectSuiteReference.rst b/Documentation/sources/Reference/suites/ofxImageEffectSuiteReference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxImageEffectSuiteV1:
 OfxImageEffectSuiteV1
 =====================

diff --git a/Documentation/sources/Reference/suites/ofxInteractSuiteReference.rst b/Documentation/sources/Reference/suites/ofxInteractSuiteReference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxInteractSuiteV1:
 OfxInteractSuiteV1
 ==================

diff --git a/Documentation/sources/Reference/suites/ofxMemorySuiteReference.rst b/Documentation/sources/Reference/suites/ofxMemorySuiteReference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxMemorySuiteV1:
 OfxMemorySuiteV1
 ================

diff --git a/Documentation/sources/Reference/suites/ofxMessageSuiteV1Reference.rst b/Documentation/sources/Reference/suites/ofxMessageSuiteV1Reference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxMessageSuiteV1:
 OfxMessageSuiteV1
 =================

diff --git a/Documentation/sources/Reference/suites/ofxMessageSuiteV2Reference.rst b/Documentation/sources/Reference/suites/ofxMessageSuiteV2Reference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxMessageSuiteV2:
 OfxMessageSuiteV2
 =================

diff --git a/Documentation/sources/Reference/suites/ofxOpenGLRenderSuiteReference.rst b/Documentation/sources/Reference/suites/ofxOpenGLRenderSuiteReference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxImageEffectOpenGLRenderSuiteV1:
 OfxImageEffectOpenGLRenderSuiteV1
 =================================

diff --git a/Documentation/sources/Reference/suites/ofxParametersSuiteReference.rst b/Documentation/sources/Reference/suites/ofxParametersSuiteReference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxParameterSuiteV1:
 OfxParameterSuiteV1
 ===================

diff --git a/Documentation/sources/Reference/suites/ofxParametricParamReference.rst b/Documentation/sources/Reference/suites/ofxParametricParamReference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxParametricParameterSuiteV1:
 OfxParametricParameterSuiteV1
 =============================

diff --git a/Documentation/sources/Reference/suites/ofxProgressSuiteReference.rst b/Documentation/sources/Reference/suites/ofxProgressSuiteReference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxProgressSuiteV1:
 OfxProgressSuiteV1
 ==================

diff --git a/Documentation/sources/Reference/suites/ofxPropertySuiteReference.rst b/Documentation/sources/Reference/suites/ofxPropertySuiteReference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxPropertySuiteV1:
 OfxPropertySuiteV1
 ==================

diff --git a/Documentation/sources/Reference/suites/ofxSuiteReference.rst b/Documentation/sources/Reference/suites/ofxSuiteReference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _suitesReference:
 
 OpenFX suites reference

diff --git a/Documentation/sources/Reference/suites/ofxThreadingSuiteReference.rst b/Documentation/sources/Reference/suites/ofxThreadingSuiteReference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxMultiThreadSuiteV1:
 OfxMultiThreadSuiteV1
 =====================

diff --git a/Documentation/sources/Reference/suites/ofxTimeLineSuiteReference.rst b/Documentation/sources/Reference/suites/ofxTimeLineSuiteReference.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. _OfxTimeLineSuiteV1:
 OfxTimeLineSuiteV1
 ==================

diff --git a/Documentation/sources/ReleaseNotes/index.rst b/Documentation/sources/ReleaseNotes/index.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 OpenFX Release Notes
 ====================
 

diff --git a/Documentation/sources/ReleaseNotes/relnotes-1.4.rst b/Documentation/sources/ReleaseNotes/relnotes-1.4.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 OpenFX Release Notes for V1.4
 =============================
 
@@ -43,5 +44,5 @@ Removals
 - :c:macro:`kOfxInteractPropViewportSize`
 - :c:macro:`kOfxParamPropPluginMayWrite`
 - :c:macro:`kOfxImageEffectPropInAnalysis`
-- :c:macro:`kOfxParamDoubleTypeNormalised*` - removed in favor of :c:macro:`kOfxParamDoubleType*`
+- :c:macro:`kOfxParamDoubleTypeNormalised` - removed in favor of :c:macro:`kOfxParamDoubleType`
 
diff --git a/Documentation/sources/ReleaseNotes/relnotes-1.5.rst b/Documentation/sources/ReleaseNotes/relnotes-1.5.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 OpenFX Release Notes for V1.5
 =============================
 

diff --git a/Documentation/sources/conf.py b/Documentation/sources/conf.py
@@ -7,6 +7,8 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
+# SPDX-License-Identifier: BSD-3-Clause
+
 import subprocess, os, shutil
 project = 'OpenFX'
 copyright = '2024, Contributors to the OpenFX Project'

diff --git a/Documentation/sources/index.rst b/Documentation/sources/index.rst
@@ -1,3 +1,4 @@
+.. SPDX-License-Identifier: CC-BY-4.0
 .. OpenFX documentation master file, created by
    sphinx-quickstart on Tue Mar 29 18:02:16 2016.
    You can adapt this file completely to your liking, but it should at least
@@ -15,15 +16,11 @@ The OpenFX documentation is organized as follows:
 - The :doc:`release notes<ReleaseNotes/index>` contains release notes, documenting changes in recent OpenFX releases.
 
 This documentation is also
-`available online <http://openfx.readthedocs.io/en/master/>`__
-and can be downloaded as a
-`PDF <https://readthedocs.org/projects/openfx/downloads/pdf/master/>`_ or
-`HTML zip <https://readthedocs.org/projects/openfx/downloads/htmlzip/master/>`__
-file.
+`available online <https://docs.openeffects.org>`__.
 
 This manual is maintained largely by volunteers.
 
-The `Creative Commons Attribution-ShareAlike 4.0 International License (CC-BY-SA 4.0) <https://creativecommons.org/licenses/by-sa/4.0/>`_ is used for this manual, which is a free and open license. Though there are certain restrictions that come with this license you may in general freely reproduce it and even make changes to it. However, rather than distribute your own version of this manual, we would much prefer if you would send any corrections or changes to the OpenFX association.
+The `Creative Commons Attribution 4.0 International License (CC-BY 4.0) <https://creativecommons.org/licenses/by/4.0/>`_ is used for this manual, which is a free and open license. Though there are certain restrictions that come with this license you may in general freely reproduce it and even make changes to it. However, rather than distribute your own version of this manual, we would much prefer if you would send any corrections or changes to the OpenFX maintainers.
 
 .. toctree::
     :maxdepth: 1

diff --git a/HostSupport/README b/HostSupport/README
@@ -64,3 +64,6 @@ Major overhaul of the thing,
          - a factory,
          - a filter for constructed objects,
          - a description of the host application to the plugin.
+
+# SPDX-License-Identifier: BSD-3-Clause
+
diff --git a/cmake/OpenFX.cmake b/cmake/OpenFX.cmake
@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: BSD-3-Clause
+
 if(NOT PLUGIN_INSTALLDIR)
   if(APPLE)
     set(PLUGIN_INSTALLDIR "/Library/OFX/Plugins/OpenFX Examples")

diff --git a/include/ofx-native-v1.5_aces-v1.3_ocio-v2.3.h b/include/ofx-native-v1.5_aces-v1.3_ocio-v2.3.h
@@ -8,7 +8,7 @@
 extern "C" {
 #endif
 
-/** @file ofxColourspaceList.h
+/** @file ofx-native-v1.5_aces-v1.3_ocio-v2.3.h
 Contains the list of supported colourspaces.
 This file was auto-generated by scripts/genColour from ofx-native-v1.5_aces-v1.3_ocio-v2.3.
 */

diff --git a/install.md b/install.md
@@ -1,3 +1,5 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
+
 # Building OpenFX: Libs and Plugins
 
 OpenFX itself is only a set of C header files, the ones in
@@ -81,3 +83,6 @@ _Linux dependencies you may need (but conan should provide these):_
 ```sh
 sudo apt install pkg-config libgl-dev
 ```
+
+
+
diff --git a/readme.md b/readme.md
@@ -1,3 +1,4 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
 ![Build](https://github.com/AcademySoftwareFoundation/openfx/actions/workflows/build.yml/badge.svg)
 
 # OpenFX image processing plug-in standard

diff --git a/scripts/build-cmake.sh b/scripts/build-cmake.sh
@@ -3,6 +3,7 @@
 set -e
 
 # Build everything with Conan and CMake
+# SPDX-License-Identifier: BSD-3-Clause
 
 BUILDTYPE=Release               # "Release" or "Debug"
 VERBOSE=""