From 66a3605fd9c139959eb4752dd1846741d1a31b4f Mon Sep 17 00:00:00 2001 From: Victor Derks Date: Wed, 4 Dec 2024 12:33:36 +0100 Subject: [PATCH] Add REUSE compatibility (#338) - Follow the best practices of https://reuse.software/ to ensure BSD-3 licence is correctly applied. - Add a badge to README.md - Note: remove arm build as the CI pipeline is broken for this architecture --- .github/workflows/reuse.yml | 16 ++++++++++ CHANGELOG.md | 5 ++++ CMakeLists.txt | 2 +- CharLS.sln.DotSettings | 1 + Directory.Build.props | 6 +++- LICENSES/BSD-3-Clause.txt | 11 +++++++ README.md | 8 +++-- REUSE.toml | 43 ++++++++++++++++++++++++++ SECURITY.md | 5 ++++ appveyor.yml | 3 ++ azure-pipelines.yml | 5 ---- benchmark/README.md | 5 ++++ default.ruleset.md | 50 ++++++++++++++++++++----------- doc/requirements.md | 5 ++++ doc/style_and_design.md | 5 ++++ fuzzing/libfuzzer/README.md | 5 ++++ samples/README.md | 7 ++++- src/charls-template.pc | 3 ++ unittest/CodeCoverage.runsettings | 6 +++- 19 files changed, 162 insertions(+), 29 deletions(-) create mode 100644 .github/workflows/reuse.yml create mode 100644 LICENSES/BSD-3-Clause.txt create mode 100644 REUSE.toml diff --git a/.github/workflows/reuse.yml b/.github/workflows/reuse.yml new file mode 100644 index 0000000..d638fca --- /dev/null +++ b/.github/workflows/reuse.yml @@ -0,0 +1,16 @@ +# SPDX-FileCopyrightText: © 2024 Team CharLS +# SPDX-License-Identifier: BSD-3-Clause + +name: REUSE Compliance Check + +on: [push, pull_request] + +jobs: + reuse-compliance-check: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: REUSE Compliance Check + uses: fsfe/reuse-action@v5 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 1d01ea8..dc6152b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,8 @@ + + # Changelog All notable changes to this project are documented in this file. diff --git a/CMakeLists.txt b/CMakeLists.txt index 6270181..6ee6bd5 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,7 +1,7 @@ # Copyright (c) Team CharLS. # SPDX-License-Identifier: BSD-3-Clause -cmake_minimum_required(VERSION 3.16...3.30) +cmake_minimum_required(VERSION 3.16...3.31) # Extract the version info from version.h file(READ "include/charls/version.h" version) diff --git a/CharLS.sln.DotSettings b/CharLS.sln.DotSettings index 9caab22..5e71b4d 100644 --- a/CharLS.sln.DotSettings +++ b/CharLS.sln.DotSettings @@ -98,6 +98,7 @@ True True True + True True True True diff --git a/Directory.Build.props b/Directory.Build.props index 0dc3bd8..ef938bc 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -1,4 +1,8 @@ - + + diff --git a/LICENSES/BSD-3-Clause.txt b/LICENSES/BSD-3-Clause.txt new file mode 100644 index 0000000..ea890af --- /dev/null +++ b/LICENSES/BSD-3-Clause.txt @@ -0,0 +1,11 @@ +Copyright (c) . + +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md index e5b4572..e2f9dfb 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,14 @@ + JPEG-LS Logo # CharLS [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://raw.githubusercontent.com/team-charls/charls/main/LICENSE.md) +[![REUSE status](https://api.reuse.software/badge/github.com/team-charls/charls)](https://api.reuse.software/info/github.com/team-charls/charls) [![Build status](https://ci.appveyor.com/api/projects/status/yq0naf3v2m8nfa8r/branch/main?svg=true)](https://ci.appveyor.com/project/vbaderks/charls/branch/main) [![Build Status](https://dev.azure.com/team-charls/charls/_apis/build/status/team-charls.charls?branchName=main)](https://dev.azure.com/team-charls/charls/_build/latest?definitionId=2&branchName=main) [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=team-charls_charls&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=team-charls_charls) @@ -43,7 +48,7 @@ The following JPEG-LS options are not supported by the CharLS implementation. Mo #### Note about JPEG-LS part 2 -After releasing the original baseline JPEG-LS standard ISO 14495-1:1999, ISO released an extension to the JPEG-LS standard called ISO/IEC 14495-2:2003: "Lossless and near-lossless compression of continuous-tone still images: Extensions". Currently CharLS doesn't support these extensions. +After releasing the original baseline JPEG-LS standard ISO 14495-1:1999, ISO released an extension to the JPEG-LS standard called ISO/IEC 14495-2:2003: "Lossless and near-lossless compression of continuous-tone still images: Extensions". CharLS doesn't support this extension. ## Supported platforms @@ -61,7 +66,6 @@ The code is regularly compiled/tested on Windows and 64 bit Linux. Additionally, | MSVC | >= 2019 | | Apple Clang | >= 12 | - ## Getting Started With [vcpkg](https://github.com/Microsoft/vcpkg) on Windows diff --git a/REUSE.toml b/REUSE.toml new file mode 100644 index 0000000..42d4434 --- /dev/null +++ b/REUSE.toml @@ -0,0 +1,43 @@ +# SPDX-FileCopyrightText: © 2024 Team CharLS +# SPDX-License-Identifier: BSD-3-Clause + +# This is a configuration file for the reuse lint tool. It allows specifing license info +# for files that cannot be extended with such info. + +version = 1 + +[[annotations]] +path = [ + "**.jls", + "**.bmp", + "**.png", + "**.pgm", + "**.ppm", + "**.raw", + "**.vcxproj", + "**.filters", + "**.cd", + "**.json", + "**app.manifest", + "spelling.dic", + "default.ruleset", + "src/charls.version", + "CharLS.sln", + "CharLS.sln.DotSettings", + "test/MR2_UNC" +] +precedence = "aggregate" +SPDX-FileCopyrightText = "© 2024 Team CharLS" +SPDX-License-Identifier = "BSD-3-Clause" + +[[annotations]] +path = [ + "test/conformance/README.md", + "test/conformance/*.jls", + "test/conformance/*.pgm", + "test/conformance/*.ppm", +] +precedence = "aggregate" +SPDX-FileCopyrightText = "Copyright (c) Hewlett-Packard Company 1995-1999" +SPDX-License-Identifier = "BSD-3-Clause" + diff --git a/SECURITY.md b/SECURITY.md index 141c7ea..c05e71d 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,3 +1,8 @@ + + # Security Policy ## Supported Versions diff --git a/appveyor.yml b/appveyor.yml index 070d159..6484461 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: © 2015 Team CharLS +# SPDX-License-Identifier: BSD-3-Clause + version: 2.1.1.{build} os: Visual Studio 2019 configuration: diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 55b5935..5a967d0 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -95,11 +95,6 @@ jobs: Architecture: x86 Shared: 'OFF' - ARM Release: - BuildType: Release - Architecture: x64_arm - Shared: 'OFF' - ARM64 Release: BuildType: Release Architecture: x64_arm64 diff --git a/benchmark/README.md b/benchmark/README.md index afdf428..8be41e0 100644 --- a/benchmark/README.md +++ b/benchmark/README.md @@ -1,3 +1,8 @@ + + # Benchmark The Visual Studio project in this folder contains benchmarks to analyze different way of diff --git a/default.ruleset.md b/default.ruleset.md index f22a8d2..641f8a9 100644 --- a/default.ruleset.md +++ b/default.ruleset.md @@ -1,28 +1,42 @@ + + # Comments on disabled Visual Studio C++ Core Guidelines Rules -C26426: Global initializer calls a non-constexpr function 'xxx' --> Rationale: many false warnings. CharLS is a library, globals are correctly initialized. +This document contains the rationales why some Microsoft +C++ warnings are disabled in the file default.ruleset +It is not possible to add this info to the .ruleset file itself as edit actions +with the VS GUI would cause the comments to get lost. +Most of disabled rules\warning are based on the C++ Core Guidelines that require +usage of the gsl helper library. -C26429: Symbol 'xxx' is never tested for nullness, it can be marked as not_null (f.23). --> Rationale: Prefast attributes are better. +## Warnings -C26446: Prefer to use gsl::at() instead of unchecked subscript operator. - -> Rationale: CharLS require good performance, gsl:at() cannot be used. debug STL already checks. +- C26426: Global initializer calls a non-constexpr function 'xxx' +**Rationale**: many false warnings. CharLS is a library, globals are correctly initialized. -C26459: You called an STL function '' with a raw pointer parameter. Consider wrapping your range in a gsl::span and pass as a span iterator (stl.1) -Rationale: gsl:span() cannot be used. Update to std:span when available (C++20). +- C26429: Symbol 'xxx' is never tested for nullness, it can be marked as not_null (f.23). +**Rationale**: Prefast attributes are better. -C26472: Don't use static_cast for arithmetic conversions - -> Rationale: can only be solved with gsl::narrow_cast +- C26446: Prefer to use gsl::at() instead of unchecked subscript operator. + **Rationale**: CharLS require good performance, gsl:at() cannot be used. debug STL already checks. -C26481: Do not pass an array as a single pointer. --> Rationale: gsl::span is not available. +- C26459: You called an STL function '' with a raw pointer parameter. Consider wrapping your range in a gsl::span and pass as a span iterator (stl.1) +**Rationale**: gsl:span() cannot be used. Update to std:span when available (C++20). -C26482: Only index into arrays using constant expressions. --> Rationale: static analysis can verify access, std::array during runtime (debug) +- C26472: Don't use static_cast for arithmetic conversions + **Rationale**: can only be solved with gsl::narrow_cast -C26490: Don't use reinterpret_cast --> Rationale: required to cast unsigned char\* to char\*. +- C26481: Do not pass an array as a single pointer. +**Rationale**: gsl::span is not available. -C26494: Variable 'x' is uninitialized. Always initialize an object --> Rationale: many false warnings, other analyzers are better. +- C26482: Only index into arrays using constant expressions. +**Rationale**: static analysis can verify access, std::array during runtime (debug) + +- C26490: Don't use reinterpret_cast +**Rationale**: required to cast unsigned char\* to char\*. + +- C26494: Variable 'x' is uninitialized. Always initialize an object +**Rationale**: many false warnings, already covered with other analyzers. diff --git a/doc/requirements.md b/doc/requirements.md index fa52034..393499e 100644 --- a/doc/requirements.md +++ b/doc/requirements.md @@ -1,3 +1,8 @@ + + # Style and Design ## Introduction diff --git a/doc/style_and_design.md b/doc/style_and_design.md index 2c37fa7..ddebad8 100644 --- a/doc/style_and_design.md +++ b/doc/style_and_design.md @@ -1,3 +1,8 @@ + + # Style and Design ## Introduction diff --git a/fuzzing/libfuzzer/README.md b/fuzzing/libfuzzer/README.md index 98e9409..2c12b2d 100644 --- a/fuzzing/libfuzzer/README.md +++ b/fuzzing/libfuzzer/README.md @@ -1,3 +1,8 @@ + + # Instructions to fuzz CharLS with LibFuzzer - It is in general recommended to fuzz the release builds. diff --git a/samples/README.md b/samples/README.md index da154c1..d0d971e 100644 --- a/samples/README.md +++ b/samples/README.md @@ -1,3 +1,8 @@ + + The C/C++ samples applications are created for simplicity and to demonstrate how the use the CharLS API. They are not production quality. In particular they -should not be installed in binary distribution as reference command line utils +should not be installed in binary distribution as reference command line utils. diff --git a/src/charls-template.pc b/src/charls-template.pc index b8be322..a69c5d2 100644 --- a/src/charls-template.pc +++ b/src/charls-template.pc @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: © 2020 Team CharLS +# SPDX-License-Identifier: BSD-3-Clause + prefix=@CMAKE_INSTALL_PREFIX@ exec_prefix=${prefix} libdir=${prefix}/@CMAKE_INSTALL_LIBDIR@ diff --git a/unittest/CodeCoverage.runsettings b/unittest/CodeCoverage.runsettings index 9c43b7d..97d3ddb 100644 --- a/unittest/CodeCoverage.runsettings +++ b/unittest/CodeCoverage.runsettings @@ -1,4 +1,8 @@ - + +