From 2c1438fa0d3d8f2471abc81e10da7f20e3c96037 Mon Sep 17 00:00:00 2001 From: Enrico Seiler Date: Wed, 7 Feb 2024 13:01:42 +0100 Subject: [PATCH] [MISC] SPDX license header --- .clang-format | 4 + .cmake-format.yaml | 4 + .codecov.yml | 4 + .github/ISSUE_TEMPLATE/bug_report.yml | 4 + .github/ISSUE_TEMPLATE/config.yml | 4 + .../cron_comment_template.md.license | 3 + .../release-checklist.md.license | 3 + .github/dependabot.yml | 4 + .github/workflows/api.yml | 4 + .github/workflows/ci_cmake.yml | 4 + .github/workflows/ci_coverage.yml | 4 + .github/workflows/ci_documentation.yml | 4 + .github/workflows/ci_license.yml | 41 +++++ .github/workflows/ci_linux.yml | 4 + .github/workflows/ci_macos.yml | 4 + .github/workflows/ci_misc.yml | 4 + .github/workflows/documentation.yml | 4 + .github/workflows/lint.yml | 4 + .github/workflows/readme_snippet.yml | 4 + .github/workflows/scripts/gcov.sh | 4 + .github/workflows/update_cookbook.yml | 4 + .gitignore | 4 + .gitmodules | 4 + .gitpod.yml | 4 + CHANGELOG.md | 6 + CMakeLists.txt | 9 +- CODE_OF_CONDUCT.md | 12 +- CONTRIBUTING.md | 6 + LICENSE.md | 4 +- LICENSES/BSD-3-Clause.txt | 11 ++ LICENSES/CC-BY-4.0.txt | 156 ++++++++++++++++++ LICENSES/CC0-1.0.txt | 121 ++++++++++++++ LICENSES/MIT.txt | 9 + README.md | 8 +- build_system/sharg-config-version.cmake | 9 +- build_system/sharg-config.cmake | 9 +- build_system/sharg-install.cmake | 9 +- build_system/sharg-package.cmake | 9 +- doc/about/api/index.md | 6 + doc/about/copyright/bsdl_badge.svg.license | 2 + doc/about/copyright/cc0_badge.svg.license | 2 + doc/about/copyright/ccby_badge.svg.license | 2 + .../copyright/copyfree_badge.svg.license | 2 + doc/about/customisation/index.md | 6 + doc/about/update_notifications/index.md | 6 + doc/cookbook/basic_arg_parse.cpp | 4 + doc/cookbook/basic_arg_parse.out.license | 3 + doc/cookbook/index.md | 6 + doc/howto/custom_types/custom_type.cpp | 4 + .../custom_types/custom_type.out.license | 3 + .../custom_types/external_custom_type.cpp | 4 + .../external_custom_type.out.license | 3 + doc/howto/custom_types/index.md | 6 + .../custom_validator_solution1.cpp | 4 + doc/howto/custom_validator/index.md | 6 + doc/howto/subcommand_parser/index.md | 6 + .../subcommand_parser/subcommand_parse.cpp | 4 + .../subcommand_parse.out.license | 3 + doc/main_page.md | 6 + doc/setup/library_tests/index.md | 6 + doc/setup/quickstart_cmake/index.md | 6 + .../concepts/custom_validator_solution.cpp | 4 + .../custom_validator_solution.out.license | 3 + doc/tutorial/parser/basic_parser_setup.cpp | 4 + .../parser/basic_parser_setup.out.license | 3 + doc/tutorial/parser/data.tsv.license | 3 + doc/tutorial/parser/disable_version_check.cpp | 4 + doc/tutorial/parser/index.md | 6 + doc/tutorial/parser/small_snippets.cpp | 6 +- doc/tutorial/parser/solution1.cpp | 4 + doc/tutorial/parser/solution3.cpp | 4 + doc/tutorial/parser/solution3.out.license | 3 + doc/tutorial/parser/solution4.cpp | 4 + doc/tutorial/parser/solution4.out.license | 3 + doc/tutorial/parser/solution5.cpp | 4 + doc/tutorial/parser/solution5.out.license | 3 + doc/tutorial/parser/solution6.cpp | 4 + doc/tutorial/parser/solution6.out.license | 3 + include/sharg/all.hpp | 9 +- include/sharg/auxiliary.hpp | 9 +- include/sharg/concept.hpp | 9 +- include/sharg/config.hpp | 9 +- include/sharg/detail/concept.hpp | 9 +- include/sharg/detail/format_base.hpp | 11 +- include/sharg/detail/format_help.hpp | 13 +- include/sharg/detail/format_html.hpp | 9 +- include/sharg/detail/format_man.hpp | 9 +- include/sharg/detail/format_parse.hpp | 9 +- include/sharg/detail/format_tdl.hpp | 9 +- .../sharg/detail/safe_filesystem_entry.hpp | 9 +- include/sharg/detail/terminal.hpp | 9 +- include/sharg/detail/test_accessor.hpp | 9 +- include/sharg/detail/to_string.hpp | 9 +- include/sharg/detail/type_name_as_string.hpp | 9 +- include/sharg/detail/version_check.hpp | 9 +- include/sharg/enumeration_names.hpp | 9 +- include/sharg/exceptions.hpp | 9 +- include/sharg/parser.hpp | 9 +- include/sharg/platform.hpp | 9 +- include/sharg/std/charconv | 9 +- include/sharg/validators.hpp | 9 +- include/sharg/version.hpp | 9 +- ...ions-at-the-end-of-the-help-.patch.license | 3 + .../0002-NOAPI-Update-copyright.patch.license | 3 + ...-FIX-Check-app_name-at-parse.patch.license | 3 + .../0004-FIX-API-tdl-support.patch.license | 3 + .../1.1.1/0001-API-Update-TDL.patch | 4 +- .../1.1.1/0001-API-Update-TDL.patch.license | 3 + .../0002-API-Quoted-strings-and-paths.patch | 4 +- ...API-Quoted-strings-and-paths.patch.license | 3 + .../1.1.1/0003-NOAPI-Update-copyright.patch | 125 ++++++++++++++ .../0003-NOAPI-Update-copyright.patch.license | 3 + test/api_stability/CMakeLists.txt | 4 + test/api_stability/README.md | 33 ++-- test/cmake/add_subdirectories.cmake | 9 +- .../diagnostics/list_missing_unit_tests.cmake | 9 +- .../diagnostics/list_unused_snippets.cmake | 9 +- .../diagnostics/list_unused_unit_tests.cmake | 9 +- .../add_include_dependencies.cmake | 9 +- .../generate_include_dependencies.cmake | 9 +- test/cmake/sharg_generate_snippet.cmake | 9 +- test/cmake/sharg_macro_benchmark.cmake | 9 +- test/cmake/sharg_path_longest_stem.cmake | 9 +- test/cmake/sharg_require_benchmark.cmake | 9 +- test/cmake/sharg_require_ccache.cmake | 9 +- test/cmake/sharg_require_test.cmake | 9 +- test/cmake/sharg_test_component.cmake | 9 +- test/cmake/sharg_test_files.cmake | 9 +- test/coverage/CMakeLists.txt | 9 +- test/documentation/.vercel/README.md | 6 + test/documentation/.vercel/build.sh | 5 + test/documentation/.vercel/index.html | 6 + test/documentation/.vercel/install.sh | 5 + .../.vercel/powered-by-vercel.svg.license | 3 + test/documentation/.vercel/vercel.css | 6 + test/documentation/CMakeLists.txt | 9 +- test/documentation/DoxygenLayout.xml.in | 5 + test/documentation/README.md | 6 + test/documentation/api-stability.js | 4 + test/documentation/doc_dev/CMakeLists.txt | 9 +- test/documentation/doc_usr/CMakeLists.txt | 9 +- .../doxygen-awesome-darkmode-toggle.js | 7 +- .../doxygen-awesome-fragment-copy-button.js | 7 +- .../doxygen-awesome-interactive-toc.js | 5 +- .../doxygen-awesome-paragraph-link.js | 3 + .../doxygen-awesome/doxygen-awesome-tabs.js | 5 +- .../doxygen-awesome/doxygen-awesome.css | 37 +++-- .../documentation/sharg-doxygen-package.cmake | 9 +- test/documentation/sharg-doxygen.cmake | 9 +- test/documentation/sharg.css | 6 + test/documentation/sharg_doxygen_cfg.in | 4 + test/documentation/sharg_footer.html.in | 5 + test/documentation/sharg_header.html | 6 + test/documentation/sharg_logo.svg.license | 3 + test/documentation/version.js | 4 + test/documentation/version.php | 5 + test/external_project/CMakeLists.txt | 9 +- .../find-package-diagnostics.cmake | 9 +- test/external_project/install-sharg.cmake | 9 +- .../sharg_fetch_content_zip/CMakeLists.txt | 9 +- .../sharg_installed/CMakeLists.txt | 9 +- .../sharg_setup_tutorial/CMakeLists.txt | 9 +- .../CMakeLists.txt | 9 +- .../CMakeLists.txt | 9 +- test/external_project/src/hello_world.cpp | 4 + test/header/CMakeLists.txt | 9 +- test/header/generate_header_source.cmake | 4 + test/include/sharg/test/file_access.hpp | 9 +- test/include/sharg/test/tmp_filename.hpp | 9 +- test/scripts/add_snippets_to_cookbook.sh | 9 +- test/scripts/check_markdown_doxygen.sh | 50 ++++++ test/scripts/link_check.sh | 9 +- test/scripts/update_copyright.sh | 23 ++- test/sharg-test.cmake | 9 +- test/snippet/CMakeLists.txt | 9 +- test/snippet/auxiliary.cpp | 4 + test/snippet/compare_snippet_output.cmake | 4 + test/snippet/custom_enumeration.cpp | 4 + test/snippet/custom_enumeration.out.license | 3 + test/snippet/custom_parsing_enumeration.cpp | 4 + .../custom_parsing_enumeration.out.license | 3 + test/snippet/is_option_set.cpp | 4 + test/snippet/is_option_set.out.license | 3 + test/snippet/parser_1.cpp | 4 + test/snippet/parser_1.out.license | 3 + test/snippet/parser_2.cpp | 4 + test/snippet/parser_2.out.license | 3 + test/snippet/parser_3.cpp | 4 + test/snippet/parser_3.out.license | 3 + test/snippet/readme_sneak_peek.cpp | 4 + test/snippet/readme_sneak_peek.out.license | 3 + test/snippet/safe_filesystem_entry.cpp | 4 + test/snippet/snippet_main.cpp | 4 + test/snippet/validators_1.cpp | 4 + test/snippet/validators_1.out.license | 3 + test/snippet/validators_2.cpp | 4 + test/snippet/validators_2.out.license | 3 + test/snippet/validators_3.cpp | 4 + test/snippet/validators_3.out.license | 3 + test/snippet/validators_4.cpp | 4 + test/snippet/validators_4.out.license | 3 + test/snippet/validators_chaining.cpp | 4 + test/snippet/validators_chaining.out.license | 3 + test/snippet/validators_input_directory.cpp | 4 + .../validators_input_directory.out.license | 3 + test/snippet/validators_input_file.cpp | 4 + .../snippet/validators_input_file.out.license | 3 + .../validators_input_file_ext_from_file.cpp | 4 + ...ators_input_file_ext_from_file.err.license | 3 + test/snippet/validators_output_directory.cpp | 4 + .../validators_output_directory.out.license | 3 + test/snippet/validators_output_file.cpp | 4 + .../validators_output_file.out.license | 3 + .../validators_output_file_ext_from_file.cpp | 4 + ...tors_output_file_ext_from_file.err.license | 3 + test/unit/CMakeLists.txt | 9 +- test/unit/README.md | 6 + test/unit/detail/CMakeLists.txt | 9 +- test/unit/detail/format_ctd_test.cpp | 9 +- test/unit/detail/format_cwl_test.cpp | 9 +- test/unit/detail/format_help_test.cpp | 19 +-- test/unit/detail/format_html_test.cpp | 11 +- test/unit/detail/format_man_test.cpp | 19 +-- .../detail/safe_filesystem_entry_test.cpp | 9 +- test/unit/detail/seqan3_test.cpp | 9 +- test/unit/detail/type_name_as_string_test.cpp | 9 +- test/unit/detail/version_check_debug_test.cpp | 9 +- .../detail/version_check_release_test.cpp | 9 +- test/unit/detail/version_check_test.hpp | 9 +- test/unit/parser/CMakeLists.txt | 4 + test/unit/parser/enumeration_names_test.cpp | 9 +- test/unit/parser/format_parse_test.cpp | 9 +- .../parser/format_parse_validators_test.cpp | 9 +- test/unit/parser/parser_design_error_test.cpp | 9 +- test/unit/std/CMakeLists.txt | 4 + test/unit/std/charconv_float_test.cpp | 9 +- test/unit/std/charconv_int_test.cpp | 9 +- test/unit/test/CMakeLists.txt | 4 + test/unit/test/file_access_test.cpp | 9 +- test/unit/test/tmp_filename_test.cpp | 9 +- 240 files changed, 1412 insertions(+), 585 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/cron_comment_template.md.license create mode 100644 .github/ISSUE_TEMPLATE/release-checklist.md.license create mode 100644 .github/workflows/ci_license.yml create mode 100644 LICENSES/BSD-3-Clause.txt create mode 100644 LICENSES/CC-BY-4.0.txt create mode 100644 LICENSES/CC0-1.0.txt create mode 100644 LICENSES/MIT.txt create mode 100644 doc/about/copyright/bsdl_badge.svg.license create mode 100644 doc/about/copyright/cc0_badge.svg.license create mode 100644 doc/about/copyright/ccby_badge.svg.license create mode 100644 doc/about/copyright/copyfree_badge.svg.license create mode 100644 doc/cookbook/basic_arg_parse.out.license create mode 100644 doc/howto/custom_types/custom_type.out.license create mode 100644 doc/howto/custom_types/external_custom_type.out.license create mode 100644 doc/howto/subcommand_parser/subcommand_parse.out.license create mode 100644 doc/tutorial/concepts/custom_validator_solution.out.license create mode 100644 doc/tutorial/parser/basic_parser_setup.out.license create mode 100644 doc/tutorial/parser/data.tsv.license create mode 100644 doc/tutorial/parser/solution3.out.license create mode 100644 doc/tutorial/parser/solution4.out.license create mode 100644 doc/tutorial/parser/solution5.out.license create mode 100644 doc/tutorial/parser/solution6.out.license create mode 100644 test/api_stability/1.0.0/0001-API-FIX-Print-common-options-at-the-end-of-the-help-.patch.license create mode 100644 test/api_stability/1.0.0/0002-NOAPI-Update-copyright.patch.license create mode 100644 test/api_stability/1.0.0/0003-API-FIX-Check-app_name-at-parse.patch.license create mode 100644 test/api_stability/1.0.0/0004-FIX-API-tdl-support.patch.license create mode 100644 test/api_stability/1.1.1/0001-API-Update-TDL.patch.license create mode 100644 test/api_stability/1.1.1/0002-API-Quoted-strings-and-paths.patch.license create mode 100644 test/api_stability/1.1.1/0003-NOAPI-Update-copyright.patch create mode 100644 test/api_stability/1.1.1/0003-NOAPI-Update-copyright.patch.license create mode 100644 test/documentation/.vercel/powered-by-vercel.svg.license create mode 100644 test/documentation/sharg_logo.svg.license create mode 100755 test/scripts/check_markdown_doxygen.sh create mode 100644 test/snippet/custom_enumeration.out.license create mode 100644 test/snippet/custom_parsing_enumeration.out.license create mode 100644 test/snippet/is_option_set.out.license create mode 100644 test/snippet/parser_1.out.license create mode 100644 test/snippet/parser_2.out.license create mode 100644 test/snippet/parser_3.out.license create mode 100644 test/snippet/readme_sneak_peek.out.license create mode 100644 test/snippet/validators_1.out.license create mode 100644 test/snippet/validators_2.out.license create mode 100644 test/snippet/validators_3.out.license create mode 100644 test/snippet/validators_4.out.license create mode 100644 test/snippet/validators_chaining.out.license create mode 100644 test/snippet/validators_input_directory.out.license create mode 100644 test/snippet/validators_input_file.out.license create mode 100644 test/snippet/validators_input_file_ext_from_file.err.license create mode 100644 test/snippet/validators_output_directory.out.license create mode 100644 test/snippet/validators_output_file.out.license create mode 100644 test/snippet/validators_output_file_ext_from_file.err.license diff --git a/.clang-format b/.clang-format index dde13180..391b9cc8 100644 --- a/.clang-format +++ b/.clang-format @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: CC0-1.0 + # Format all files in include folder, including std module, excluding contrib module # find . \( -iname "*.hpp" -or -iname "*.cpp" \) -and -not -path "./submodules/*" -and -not -path "./build/*" | xargs clang-format-15 --style=file -i --- diff --git a/.cmake-format.yaml b/.cmake-format.yaml index bb881061..844ad12a 100644 --- a/.cmake-format.yaml +++ b/.cmake-format.yaml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: CC0-1.0 + _sharg_cmake_format_documentation_only: install: command: diff --git a/.codecov.yml b/.codecov.yml index a5092838..272c2eba 100644 --- a/.codecov.yml +++ b/.codecov.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: CC0-1.0 + # See https://docs.codecov.io/docs/codecovyml-reference codecov: token: b5e588e8-7b85-46f1-bad6-e0a5c19d7d67 diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 67663d75..6b2fd339 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: CC0-1.0 + name: 🐞 Bug report description: Create a report to help us improve Sharg. labels: [bug] diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 1f4f7610..6c428cd9 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: CC0-1.0 + blank_issues_enabled: true contact_links: - name: Questions and Answers diff --git a/.github/ISSUE_TEMPLATE/cron_comment_template.md.license b/.github/ISSUE_TEMPLATE/cron_comment_template.md.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/cron_comment_template.md.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/.github/ISSUE_TEMPLATE/release-checklist.md.license b/.github/ISSUE_TEMPLATE/release-checklist.md.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/release-checklist.md.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/.github/dependabot.yml b/.github/dependabot.yml index dcbcb650..ba5cc583 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: CC0-1.0 + # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates version: 2 diff --git a/.github/workflows/api.yml b/.github/workflows/api.yml index 0564270b..808dff87 100644 --- a/.github/workflows/api.yml +++ b/.github/workflows/api.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: CC0-1.0 + name: Sharg API-Stability on: diff --git a/.github/workflows/ci_cmake.yml b/.github/workflows/ci_cmake.yml index b38e03b7..937e8460 100644 --- a/.github/workflows/ci_cmake.yml +++ b/.github/workflows/ci_cmake.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: CC0-1.0 + name: CMake on: diff --git a/.github/workflows/ci_coverage.yml b/.github/workflows/ci_coverage.yml index a1c1a46e..9feedcf1 100644 --- a/.github/workflows/ci_coverage.yml +++ b/.github/workflows/ci_coverage.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: CC0-1.0 + name: Coverage on: diff --git a/.github/workflows/ci_documentation.yml b/.github/workflows/ci_documentation.yml index 0c0e67ab..75fbe727 100644 --- a/.github/workflows/ci_documentation.yml +++ b/.github/workflows/ci_documentation.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: CC0-1.0 + name: Documentation on: diff --git a/.github/workflows/ci_license.yml b/.github/workflows/ci_license.yml new file mode 100644 index 00000000..db4eae17 --- /dev/null +++ b/.github/workflows/ci_license.yml @@ -0,0 +1,41 @@ +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: CC0-1.0 + +name: License + +on: + push: + branches: + - 'main' + pull_request: + types: + - unlabeled + workflow_dispatch: + +concurrency: + group: license-${{ github.event.pull_request.number || github.ref }} + cancel-in-progress: ${{ github.event_name != 'push' }} + +env: + TZ: Europe/Berlin + +defaults: + run: + shell: bash -Eexuo pipefail {0} + +jobs: + check: + name: REUSE Compliance + runs-on: ubuntu-22.04 + timeout-minutes: 120 + if: github.repository_owner == 'seqan' || github.event_name == 'workflow_dispatch' || github.event.label.name == 'lint' + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: REUSE Compliance Check + uses: fsfe/reuse-action@v2 + + - name: Check Markdown files for doxygen + run: ${{ github.workspace }}/test/scripts/check_markdown_doxygen.sh ${{ github.workspace }} diff --git a/.github/workflows/ci_linux.yml b/.github/workflows/ci_linux.yml index afbdc900..f9fbffbb 100644 --- a/.github/workflows/ci_linux.yml +++ b/.github/workflows/ci_linux.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: CC0-1.0 + name: Unit Linux on: diff --git a/.github/workflows/ci_macos.yml b/.github/workflows/ci_macos.yml index 9ce06db2..00ba47da 100644 --- a/.github/workflows/ci_macos.yml +++ b/.github/workflows/ci_macos.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: CC0-1.0 + name: Unit macOS on: diff --git a/.github/workflows/ci_misc.yml b/.github/workflows/ci_misc.yml index 11596f1a..59802144 100644 --- a/.github/workflows/ci_misc.yml +++ b/.github/workflows/ci_misc.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: CC0-1.0 + name: Linux on: diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 7297b477..e9a4c607 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: CC0-1.0 + name: Deploy documentation (https://docs.seqan.de/) on: diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 36dc7c62..c2777574 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: CC0-1.0 + name: Lint on: diff --git a/.github/workflows/readme_snippet.yml b/.github/workflows/readme_snippet.yml index f22adc59..40c19a1f 100644 --- a/.github/workflows/readme_snippet.yml +++ b/.github/workflows/readme_snippet.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: CC0-1.0 + name: Sharg Markdown on: diff --git a/.github/workflows/scripts/gcov.sh b/.github/workflows/scripts/gcov.sh index 9e38db66..86ba2abf 100755 --- a/.github/workflows/scripts/gcov.sh +++ b/.github/workflows/scripts/gcov.sh @@ -1,5 +1,9 @@ #!/usr/bin/env bash +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: CC0-1.0 + args=${@/--branch-counts/""} args=${args/--branch-probabilities/""} diff --git a/.github/workflows/update_cookbook.yml b/.github/workflows/update_cookbook.yml index ff399a16..9a09ffef 100644 --- a/.github/workflows/update_cookbook.yml +++ b/.github/workflows/update_cookbook.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: CC0-1.0 + name: Sharg lint on: diff --git a/.gitignore b/.gitignore index 6c644a00..e50fe774 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: CC0-1.0 + # Prerequisites *.d diff --git a/.gitmodules b/.gitmodules index c7750963..b141929b 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: CC0-1.0 + [submodule "submodules/tool_description_lib"] path = submodules/tool_description_lib url = https://github.com/deNBI-cibi/tool_description_lib.git diff --git a/.gitpod.yml b/.gitpod.yml index 4d097b4a..d3fe3366 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: CC0-1.0 + # https://www.gitpod.io/docs/references/gitpod-yml checkoutLocation: "tutorial/sharg-parser" workspaceLocation: "/tutorial" diff --git a/CHANGELOG.md b/CHANGELOG.md index a1f4bd27..785fa5db 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Changelog {#about_changelog} + + [TOC] This changelog contains a top-level entry for each release with sections on new features, API changes and notable diff --git a/CMakeLists.txt b/CMakeLists.txt index 178a55a4..0c7c259e 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause # This file provides functionality common to the different test modules used by # Sharg. To build tests, run cmake on one of the sub-folders in this directory diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index b4616667..707ec8ec 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,7 +1,13 @@ # Code of Conduct {#about_code_of_conduct} + + The Sharg-parser adheres to the [Berlin Code of Conduct](https://berlincodeofconduct.org/). As the Sharg-parser was -created and is maintained by the SeqAn team, it is part of the SeqAn project. Therefore, SeqAn's Code of Conduct -applies to the Sharg-parser as well. Please see -[SeqAn's Code of Conduct](http://docs.seqan.de/seqan/3-master-user/about_code_of_conduct.html) for more +created and is maintained by the SeqAn team, it is part of the SeqAn project. Therefore, SeqAn's Code of Conduct +applies to the Sharg-parser as well. Please see +[SeqAn's Code of Conduct](http://docs.seqan.de/seqan/3-master-user/about_code_of_conduct.html) for more information on our Code of Conduct. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 29282be9..0174994f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,11 @@ # Contributing {#about_contributing} + + First of all, thanks for wanting to contribute to the SeqAn's Sharg-parser! Community is important to us and we strive to maintain a great culture and atmosphere. Please have a look at our [Code of Conduct](\ref about_code_of_conduct). diff --git a/LICENSE.md b/LICENSE.md index 28c61b69..4de300cd 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -14,8 +14,8 @@ The contents of this repository/directory, in particular the library source code of Sharg, are licensed under the following terms: ``` -Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik +Copyright (c) 2006-2024, Knut Reinert & Freie Universität Berlin +Copyright (c) 2016-2024, Knut Reinert & MPI für molekulare Genetik All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/LICENSES/BSD-3-Clause.txt b/LICENSES/BSD-3-Clause.txt new file mode 100644 index 00000000..ea890afb --- /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/LICENSES/CC-BY-4.0.txt b/LICENSES/CC-BY-4.0.txt new file mode 100644 index 00000000..13ca539f --- /dev/null +++ b/LICENSES/CC-BY-4.0.txt @@ -0,0 +1,156 @@ +Creative Commons Attribution 4.0 International + + Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses. + +Considerations for licensors: Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. More considerations for licensors. + +Considerations for the public: By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described. Although not required by our licenses, you are encouraged to respect those requests where reasonable. More considerations for the public. + +Creative Commons Attribution 4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions. + +Section 1 – Definitions. + + a. Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License. + + c. Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. + + d. Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements. + + e. Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material. + + f. Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License. + + g. Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license. + + h. Licensor means the individual(s) or entity(ies) granting rights under this Public License. + + i. Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them. + + j. Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world. + + k. You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning. + +Section 2 – Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to: + + A. reproduce and Share the Licensed Material, in whole or in part; and + + B. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions. + + 3. Term. The term of this Public License is specified in Section 6(a). + + 4. Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material. + + 5. Downstream recipients. + + A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License. + + B. No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material. + + 6. No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i). + +b. Other rights. + + 1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this Public License. + + 3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties. + +Section 3 – License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified form), You must: + + A. retain the following if it is supplied by the Licensor with the Licensed Material: + + i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of warranties; + + v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; + + B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and + + C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information. + + 3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable. + + 4. If You Share Adapted Material You produce, the Adapter's License You apply must not prevent recipients of the Adapted Material from complying with this Public License. + +Section 4 – Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database; + + b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material; and + + c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database. +For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights. + +Section 5 – Disclaimer of Warranties and Limitation of Liability. + + a. Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You. + + b. To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You. + + c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability. + +Section 6 – Term and Termination. + + a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or + + 2. upon express reinstatement by the Licensor. + + c. For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License. + + d. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License. + + e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. + +Section 7 – Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License. + +Section 8 – Interpretation. + + a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions. + + c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor. + + d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority. + +Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at creativecommons.org/policies, Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/LICENSES/CC0-1.0.txt b/LICENSES/CC0-1.0.txt new file mode 100644 index 00000000..0e259d42 --- /dev/null +++ b/LICENSES/CC0-1.0.txt @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. diff --git a/LICENSES/MIT.txt b/LICENSES/MIT.txt new file mode 100644 index 00000000..2071b23b --- /dev/null +++ b/LICENSES/MIT.txt @@ -0,0 +1,9 @@ +MIT License + +Copyright (c) + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index 16f8e537..75c7fc37 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,12 @@ [![platforms][api_badge]][api_link] [![twitter][twitter_badge]][twitter_link] + + + ```cpp #include diff --git a/build_system/sharg-config-version.cmake b/build_system/sharg-config-version.cmake index 1e4c7577..2bb7a3ae 100644 --- a/build_system/sharg-config-version.cmake +++ b/build_system/sharg-config-version.cmake @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause # This file adds version support for `find_package(SHARG 3.1)`. # See https://cmake.org/cmake/help/v3.16/manual/cmake-packages.7.html#package-version-file for more information. diff --git a/build_system/sharg-config.cmake b/build_system/sharg-config.cmake index 46f15caf..0bcaa3fc 100644 --- a/build_system/sharg-config.cmake +++ b/build_system/sharg-config.cmake @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause # # This CMake module will try to find SHARG and its dependencies. You can use # it the same way you would use any other CMake module. diff --git a/build_system/sharg-install.cmake b/build_system/sharg-install.cmake index c66600ed..02e95241 100644 --- a/build_system/sharg-install.cmake +++ b/build_system/sharg-install.cmake @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause # This file describes where and which parts of Sharg should be installed to. diff --git a/build_system/sharg-package.cmake b/build_system/sharg-package.cmake index f4f688ca..6281ad5f 100644 --- a/build_system/sharg-package.cmake +++ b/build_system/sharg-package.cmake @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause # This file describes how Sharg will be packaged. diff --git a/doc/about/api/index.md b/doc/about/api/index.md index 2a16b67b..974e1629 100644 --- a/doc/about/api/index.md +++ b/doc/about/api/index.md @@ -1,5 +1,11 @@ # Stability and long-term promises {#about_api} + + [TOC] # Application Programming Interface (API) stability {#api_stability} diff --git a/doc/about/copyright/bsdl_badge.svg.license b/doc/about/copyright/bsdl_badge.svg.license new file mode 100644 index 00000000..f14d0d5c --- /dev/null +++ b/doc/about/copyright/bsdl_badge.svg.license @@ -0,0 +1,2 @@ +SPDX-FileCopyrightText: Shields IO Project Contributors +SPDX-License-Identifier: CC0-1.0 diff --git a/doc/about/copyright/cc0_badge.svg.license b/doc/about/copyright/cc0_badge.svg.license new file mode 100644 index 00000000..f14d0d5c --- /dev/null +++ b/doc/about/copyright/cc0_badge.svg.license @@ -0,0 +1,2 @@ +SPDX-FileCopyrightText: Shields IO Project Contributors +SPDX-License-Identifier: CC0-1.0 diff --git a/doc/about/copyright/ccby_badge.svg.license b/doc/about/copyright/ccby_badge.svg.license new file mode 100644 index 00000000..f14d0d5c --- /dev/null +++ b/doc/about/copyright/ccby_badge.svg.license @@ -0,0 +1,2 @@ +SPDX-FileCopyrightText: Shields IO Project Contributors +SPDX-License-Identifier: CC0-1.0 diff --git a/doc/about/copyright/copyfree_badge.svg.license b/doc/about/copyright/copyfree_badge.svg.license new file mode 100644 index 00000000..f14d0d5c --- /dev/null +++ b/doc/about/copyright/copyfree_badge.svg.license @@ -0,0 +1,2 @@ +SPDX-FileCopyrightText: Shields IO Project Contributors +SPDX-License-Identifier: CC0-1.0 diff --git a/doc/about/customisation/index.md b/doc/about/customisation/index.md index cc36bd30..082511dd 100644 --- a/doc/about/customisation/index.md +++ b/doc/about/customisation/index.md @@ -1,3 +1,9 @@ # Customisation {#about_customisation} + + Please see the SeqAn documentation about [customisation](https://docs.seqan.de/seqan/3-master-user/about_customisation.html). diff --git a/doc/about/update_notifications/index.md b/doc/about/update_notifications/index.md index 40db06f7..93f12023 100644 --- a/doc/about/update_notifications/index.md +++ b/doc/about/update_notifications/index.md @@ -1,5 +1,11 @@ # Update Notifications {#about_update_notifications} + + [TOC] Outdated software is a huge issue in scientific workflows. Especially when the software is not part of the packaging diff --git a/doc/cookbook/basic_arg_parse.cpp b/doc/cookbook/basic_arg_parse.cpp index 0f0c584e..0851bd58 100644 --- a/doc/cookbook/basic_arg_parse.cpp +++ b/doc/cookbook/basic_arg_parse.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include void run_program(std::filesystem::path const & reference_path, std::filesystem::path const & index_path) diff --git a/doc/cookbook/basic_arg_parse.out.license b/doc/cookbook/basic_arg_parse.out.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/doc/cookbook/basic_arg_parse.out.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/doc/cookbook/index.md b/doc/cookbook/index.md index e4ad9fc6..5d77cee3 100644 --- a/doc/cookbook/index.md +++ b/doc/cookbook/index.md @@ -1,5 +1,11 @@ # The Sharg Cookbook {#cookbook} + + [TOC] This document provides example recipes on how to carry out particular tasks using the Sharg functionalities in C++. diff --git a/doc/howto/custom_types/custom_type.cpp b/doc/howto/custom_types/custom_type.cpp index 6abfe502..5df73a77 100644 --- a/doc/howto/custom_types/custom_type.cpp +++ b/doc/howto/custom_types/custom_type.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include // my custom type diff --git a/doc/howto/custom_types/custom_type.out.license b/doc/howto/custom_types/custom_type.out.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/doc/howto/custom_types/custom_type.out.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/doc/howto/custom_types/external_custom_type.cpp b/doc/howto/custom_types/external_custom_type.cpp index 8667d6c0..5c53a16b 100644 --- a/doc/howto/custom_types/external_custom_type.cpp +++ b/doc/howto/custom_types/external_custom_type.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include // external type, i.e., you cannot change the implementation diff --git a/doc/howto/custom_types/external_custom_type.out.license b/doc/howto/custom_types/external_custom_type.out.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/doc/howto/custom_types/external_custom_type.out.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/doc/howto/custom_types/index.md b/doc/howto/custom_types/index.md index 361bd80c..e09130ca 100644 --- a/doc/howto/custom_types/index.md +++ b/doc/howto/custom_types/index.md @@ -1,5 +1,11 @@ # How to make your custom type model sharg::parsable {#fulfil_parsable} + + [TOC] This HowTo guides you through satisfying the requirements of sharg::parsable. diff --git a/doc/howto/custom_validator/custom_validator_solution1.cpp b/doc/howto/custom_validator/custom_validator_solution1.cpp index 72e55fc9..53124813 100644 --- a/doc/howto/custom_validator/custom_validator_solution1.cpp +++ b/doc/howto/custom_validator/custom_validator_solution1.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include struct custom_validator diff --git a/doc/howto/custom_validator/index.md b/doc/howto/custom_validator/index.md index ab4b2b6c..d0890686 100644 --- a/doc/howto/custom_validator/index.md +++ b/doc/howto/custom_validator/index.md @@ -1,5 +1,11 @@ # How to make your own validator {#custom_validator} + + [TOC] This HowTo guides you through implementing your own `sharg::validator`. diff --git a/doc/howto/subcommand_parser/index.md b/doc/howto/subcommand_parser/index.md index 72b0f744..c1f01c43 100644 --- a/doc/howto/subcommand_parser/index.md +++ b/doc/howto/subcommand_parser/index.md @@ -1,5 +1,11 @@ # How to write a parser with subcommands {#subcommand_parse} + + [TOC] This HowTo shows you how to write a parser with subcommands like `git push` using Sharg. diff --git a/doc/howto/subcommand_parser/subcommand_parse.cpp b/doc/howto/subcommand_parser/subcommand_parse.cpp index 162b9357..dc30cf8e 100644 --- a/doc/howto/subcommand_parser/subcommand_parse.cpp +++ b/doc/howto/subcommand_parser/subcommand_parse.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include // ===================================================================================================================== diff --git a/doc/howto/subcommand_parser/subcommand_parse.out.license b/doc/howto/subcommand_parser/subcommand_parse.out.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/doc/howto/subcommand_parser/subcommand_parse.out.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/doc/main_page.md b/doc/main_page.md index 4fbde71f..ca85c89b 100644 --- a/doc/main_page.md +++ b/doc/main_page.md @@ -1,5 +1,11 @@ # Welcome {#mainpage} + + Welcome to the documentation of the Sharg parser. This web-site contains the API reference (documentation of our interfaces) and more elaborate Tutorials and How-Tos. diff --git a/doc/setup/library_tests/index.md b/doc/setup/library_tests/index.md index 7389f544..8b150e56 100644 --- a/doc/setup/library_tests/index.md +++ b/doc/setup/library_tests/index.md @@ -1,3 +1,9 @@ # Setting up library tests {#setup_tests} + + Please see the SeqAn documentation about [setup tests](https://docs.seqan.de/seqan/3-master-user/setup_tests.html). diff --git a/doc/setup/quickstart_cmake/index.md b/doc/setup/quickstart_cmake/index.md index cabe728a..bd887a68 100644 --- a/doc/setup/quickstart_cmake/index.md +++ b/doc/setup/quickstart_cmake/index.md @@ -1,5 +1,11 @@ # Quick Setup (using CMake) {#setup} + + Learning Objective:
In this short guide you will learn how to set up Sharg and how to compile a small example to test whether everything works. diff --git a/doc/tutorial/concepts/custom_validator_solution.cpp b/doc/tutorial/concepts/custom_validator_solution.cpp index 1816c8ae..049e9481 100644 --- a/doc/tutorial/concepts/custom_validator_solution.cpp +++ b/doc/tutorial/concepts/custom_validator_solution.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include //![validator] #include diff --git a/doc/tutorial/concepts/custom_validator_solution.out.license b/doc/tutorial/concepts/custom_validator_solution.out.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/doc/tutorial/concepts/custom_validator_solution.out.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/doc/tutorial/parser/basic_parser_setup.cpp b/doc/tutorial/parser/basic_parser_setup.cpp index 5cb95cba..2ecb413a 100644 --- a/doc/tutorial/parser/basic_parser_setup.cpp +++ b/doc/tutorial/parser/basic_parser_setup.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include // includes all necessary headers int main(int argc, char ** argv) diff --git a/doc/tutorial/parser/basic_parser_setup.out.license b/doc/tutorial/parser/basic_parser_setup.out.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/doc/tutorial/parser/basic_parser_setup.out.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/doc/tutorial/parser/data.tsv.license b/doc/tutorial/parser/data.tsv.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/doc/tutorial/parser/data.tsv.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/doc/tutorial/parser/disable_version_check.cpp b/doc/tutorial/parser/disable_version_check.cpp index 7527ad26..79f31e59 100644 --- a/doc/tutorial/parser/disable_version_check.cpp +++ b/doc/tutorial/parser/disable_version_check.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include int main(int argc, char ** argv) diff --git a/doc/tutorial/parser/index.md b/doc/tutorial/parser/index.md index 3d0cfb8b..d39fabdd 100644 --- a/doc/tutorial/parser/index.md +++ b/doc/tutorial/parser/index.md @@ -1,5 +1,11 @@ # Parsing command line arguments with Sharg {#tutorial_parser} + + Learning Objective:
You will learn how to use the sharg::parser class to parse command line arguments. This tutorial is a walkthrough with links to the API documentation and is also meant as a source for copy-and-paste code. diff --git a/doc/tutorial/parser/small_snippets.cpp b/doc/tutorial/parser/small_snippets.cpp index 130cdff7..41c19cfd 100644 --- a/doc/tutorial/parser/small_snippets.cpp +++ b/doc/tutorial/parser/small_snippets.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include //![validator_include] @@ -64,7 +68,7 @@ parser.add_positional_option(list_variable, sharg::config{.description = "Give m sharg::parser parser{"Example-Parser", argc, argv}; //![required_option] std::string required_variable{}; -parser.add_option(required_variable, sharg::config{.short_id = 'n', .long_id = "name", +parser.add_option(required_variable, sharg::config{.short_id = 'n', .long_id = "name", .description = "I really need a name.", .required = true}); //![required_option] } diff --git a/doc/tutorial/parser/solution1.cpp b/doc/tutorial/parser/solution1.cpp index 1bd0c6f6..335e5bc2 100644 --- a/doc/tutorial/parser/solution1.cpp +++ b/doc/tutorial/parser/solution1.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include // includes all necessary headers void initialise_parser(sharg::parser & parser) diff --git a/doc/tutorial/parser/solution3.cpp b/doc/tutorial/parser/solution3.cpp index 2da78f0f..094525af 100644 --- a/doc/tutorial/parser/solution3.cpp +++ b/doc/tutorial/parser/solution3.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + //![program] #include // includes all necessary headers diff --git a/doc/tutorial/parser/solution3.out.license b/doc/tutorial/parser/solution3.out.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/doc/tutorial/parser/solution3.out.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/doc/tutorial/parser/solution4.cpp b/doc/tutorial/parser/solution4.cpp index d257c503..34fead81 100644 --- a/doc/tutorial/parser/solution4.cpp +++ b/doc/tutorial/parser/solution4.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include // includes all necessary headers // This is the program! diff --git a/doc/tutorial/parser/solution4.out.license b/doc/tutorial/parser/solution4.out.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/doc/tutorial/parser/solution4.out.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/doc/tutorial/parser/solution5.cpp b/doc/tutorial/parser/solution5.cpp index 14e1d8af..3a6f2130 100644 --- a/doc/tutorial/parser/solution5.cpp +++ b/doc/tutorial/parser/solution5.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include // includes all necessary headers // This is the program! diff --git a/doc/tutorial/parser/solution5.out.license b/doc/tutorial/parser/solution5.out.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/doc/tutorial/parser/solution5.out.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/doc/tutorial/parser/solution6.cpp b/doc/tutorial/parser/solution6.cpp index 808b1efd..079d84b4 100644 --- a/doc/tutorial/parser/solution6.cpp +++ b/doc/tutorial/parser/solution6.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include // includes all necessary headers // This is the program! diff --git a/doc/tutorial/parser/solution6.out.license b/doc/tutorial/parser/solution6.out.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/doc/tutorial/parser/solution6.out.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/include/sharg/all.hpp b/include/sharg/all.hpp index e8c7b178..cc2556f1 100644 --- a/include/sharg/all.hpp +++ b/include/sharg/all.hpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause /*!\file * \author Svenja Mehringer diff --git a/include/sharg/auxiliary.hpp b/include/sharg/auxiliary.hpp index d20f533a..4d326312 100644 --- a/include/sharg/auxiliary.hpp +++ b/include/sharg/auxiliary.hpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause /*!\file * \author Svenja Mehringer diff --git a/include/sharg/concept.hpp b/include/sharg/concept.hpp index 449bc910..ec1b9d1f 100644 --- a/include/sharg/concept.hpp +++ b/include/sharg/concept.hpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause /*!\file * \author Svenja Mehringer diff --git a/include/sharg/config.hpp b/include/sharg/config.hpp index b937c281..0ca8e7e6 100644 --- a/include/sharg/config.hpp +++ b/include/sharg/config.hpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause /*!\file * \author Svenja Mehringer diff --git a/include/sharg/detail/concept.hpp b/include/sharg/detail/concept.hpp index 5b34718f..fe210c4f 100644 --- a/include/sharg/detail/concept.hpp +++ b/include/sharg/detail/concept.hpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause /*!\file * \author Svenja Mehringer diff --git a/include/sharg/detail/format_base.hpp b/include/sharg/detail/format_base.hpp index 575b6cc0..400ef2f3 100644 --- a/include/sharg/detail/format_base.hpp +++ b/include/sharg/detail/format_base.hpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause /*!\file * \author Svenja Mehringer @@ -593,7 +590,7 @@ class format_help_base : public format_base } derived_t().print_line(derived_t().in_bold("SeqAn Copyright: ") - + "2006-2023 Knut Reinert, FU-Berlin; released under the 3-clause BSDL.", + + "2006-2024 Knut Reinert, FU-Berlin; released under the 3-clause BSDL.", false); if (!empty(meta.citation)) diff --git a/include/sharg/detail/format_help.hpp b/include/sharg/detail/format_help.hpp index 49c67a33..7f6d80c3 100644 --- a/include/sharg/detail/format_help.hpp +++ b/include/sharg/detail/format_help.hpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause /*!\file * \author Svenja Mehringer @@ -472,8 +469,8 @@ class format_copyright : public format_help { meta = parser_meta; std::string seqan_license{ - R"(Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik + R"(Copyright (c) 2006-2024, Knut Reinert & Freie Universität Berlin +Copyright (c) 2016-2024, Knut Reinert & MPI für molekulare Genetik All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/include/sharg/detail/format_html.hpp b/include/sharg/detail/format_html.hpp index 24eafa6f..cfa93e48 100644 --- a/include/sharg/detail/format_html.hpp +++ b/include/sharg/detail/format_html.hpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause /*!\file * \author Svenja Mehringer diff --git a/include/sharg/detail/format_man.hpp b/include/sharg/detail/format_man.hpp index e975d83b..96843c23 100644 --- a/include/sharg/detail/format_man.hpp +++ b/include/sharg/detail/format_man.hpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause /*!\file * \author Svenja Mehringer diff --git a/include/sharg/detail/format_parse.hpp b/include/sharg/detail/format_parse.hpp index 74619334..3af883f9 100644 --- a/include/sharg/detail/format_parse.hpp +++ b/include/sharg/detail/format_parse.hpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause /*!\file * \author Svenja Mehringer diff --git a/include/sharg/detail/format_tdl.hpp b/include/sharg/detail/format_tdl.hpp index 03598cf5..1b9b612a 100644 --- a/include/sharg/detail/format_tdl.hpp +++ b/include/sharg/detail/format_tdl.hpp @@ -1,9 +1,6 @@ -// ----------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/master/LICENSE.md -// ----------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause /*!\file * \author Simon Gene Gottlieb diff --git a/include/sharg/detail/safe_filesystem_entry.hpp b/include/sharg/detail/safe_filesystem_entry.hpp index 00a8221c..2c7104f2 100644 --- a/include/sharg/detail/safe_filesystem_entry.hpp +++ b/include/sharg/detail/safe_filesystem_entry.hpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause /*!\file * \brief Provides sharg::detail::safe_filesystem_entry. diff --git a/include/sharg/detail/terminal.hpp b/include/sharg/detail/terminal.hpp index 07f41db2..d5a0b2a2 100644 --- a/include/sharg/detail/terminal.hpp +++ b/include/sharg/detail/terminal.hpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause /*!\file * \author Svenja Mehringer diff --git a/include/sharg/detail/test_accessor.hpp b/include/sharg/detail/test_accessor.hpp index e12bc71f..a3ceef66 100644 --- a/include/sharg/detail/test_accessor.hpp +++ b/include/sharg/detail/test_accessor.hpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause /*!\file * \brief Forward declares sharg::detail::test_accessor. diff --git a/include/sharg/detail/to_string.hpp b/include/sharg/detail/to_string.hpp index f19ba165..a8e90a67 100644 --- a/include/sharg/detail/to_string.hpp +++ b/include/sharg/detail/to_string.hpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause /*!\file * \author Svenja Mehringer diff --git a/include/sharg/detail/type_name_as_string.hpp b/include/sharg/detail/type_name_as_string.hpp index 822d5521..38e16153 100644 --- a/include/sharg/detail/type_name_as_string.hpp +++ b/include/sharg/detail/type_name_as_string.hpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause /*!\file * \brief Provides traits to inspect some information of a type, for example its name. diff --git a/include/sharg/detail/version_check.hpp b/include/sharg/detail/version_check.hpp index 0886ca8d..b57c93d8 100644 --- a/include/sharg/detail/version_check.hpp +++ b/include/sharg/detail/version_check.hpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause /*!\file * \author Svenja Mehringer diff --git a/include/sharg/enumeration_names.hpp b/include/sharg/enumeration_names.hpp index 80b9dbf7..034ecd66 100644 --- a/include/sharg/enumeration_names.hpp +++ b/include/sharg/enumeration_names.hpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause /*!\file * \author Svenja Mehringer diff --git a/include/sharg/exceptions.hpp b/include/sharg/exceptions.hpp index b03199c9..ef63548c 100644 --- a/include/sharg/exceptions.hpp +++ b/include/sharg/exceptions.hpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause /*!\file * \author Svenja Mehringer diff --git a/include/sharg/parser.hpp b/include/sharg/parser.hpp index 7e22e285..26169797 100644 --- a/include/sharg/parser.hpp +++ b/include/sharg/parser.hpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause /*!\file * \author Svenja Mehringer diff --git a/include/sharg/platform.hpp b/include/sharg/platform.hpp index d467747a..a7537367 100644 --- a/include/sharg/platform.hpp +++ b/include/sharg/platform.hpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause #pragma once diff --git a/include/sharg/std/charconv b/include/sharg/std/charconv index 319e579b..f8211d7c 100644 --- a/include/sharg/std/charconv +++ b/include/sharg/std/charconv @@ -1,10 +1,7 @@ // -*- C++ -*- -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause /*!\file * \brief The [\ header](https://en.cppreference.com/w/cpp/header/charconv) from C++17's standard library. diff --git a/include/sharg/validators.hpp b/include/sharg/validators.hpp index 66473929..f448d51c 100644 --- a/include/sharg/validators.hpp +++ b/include/sharg/validators.hpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause /*!\file * \author Svenja Mehringer diff --git a/include/sharg/version.hpp b/include/sharg/version.hpp index d7e9599a..5faa2ad1 100644 --- a/include/sharg/version.hpp +++ b/include/sharg/version.hpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause #pragma once diff --git a/test/api_stability/1.0.0/0001-API-FIX-Print-common-options-at-the-end-of-the-help-.patch.license b/test/api_stability/1.0.0/0001-API-FIX-Print-common-options-at-the-end-of-the-help-.patch.license new file mode 100644 index 00000000..706402f5 --- /dev/null +++ b/test/api_stability/1.0.0/0001-API-FIX-Print-common-options-at-the-end-of-the-help-.patch.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: BSD-3-Clause diff --git a/test/api_stability/1.0.0/0002-NOAPI-Update-copyright.patch.license b/test/api_stability/1.0.0/0002-NOAPI-Update-copyright.patch.license new file mode 100644 index 00000000..706402f5 --- /dev/null +++ b/test/api_stability/1.0.0/0002-NOAPI-Update-copyright.patch.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: BSD-3-Clause diff --git a/test/api_stability/1.0.0/0003-API-FIX-Check-app_name-at-parse.patch.license b/test/api_stability/1.0.0/0003-API-FIX-Check-app_name-at-parse.patch.license new file mode 100644 index 00000000..706402f5 --- /dev/null +++ b/test/api_stability/1.0.0/0003-API-FIX-Check-app_name-at-parse.patch.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: BSD-3-Clause diff --git a/test/api_stability/1.0.0/0004-FIX-API-tdl-support.patch.license b/test/api_stability/1.0.0/0004-FIX-API-tdl-support.patch.license new file mode 100644 index 00000000..706402f5 --- /dev/null +++ b/test/api_stability/1.0.0/0004-FIX-API-tdl-support.patch.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: BSD-3-Clause diff --git a/test/api_stability/1.1.1/0001-API-Update-TDL.patch b/test/api_stability/1.1.1/0001-API-Update-TDL.patch index f3a3958b..f71a30ab 100644 --- a/test/api_stability/1.1.1/0001-API-Update-TDL.patch +++ b/test/api_stability/1.1.1/0001-API-Update-TDL.patch @@ -1,7 +1,7 @@ -From 724ad34dea87caf2dde5f19af51d7b5527acf3a2 Mon Sep 17 00:00:00 2001 +From 27bc700234a23ea6c6c7337a427c4a3c6f2bbe55 Mon Sep 17 00:00:00 2001 From: Simon Gene Gottlieb Date: Thu, 5 Oct 2023 13:43:30 +0200 -Subject: [PATCH 1/2] [API] Update TDL +Subject: [PATCH 1/3] [API] Update TDL --- test/unit/detail/format_ctd_test.cpp | 2 +- diff --git a/test/api_stability/1.1.1/0001-API-Update-TDL.patch.license b/test/api_stability/1.1.1/0001-API-Update-TDL.patch.license new file mode 100644 index 00000000..706402f5 --- /dev/null +++ b/test/api_stability/1.1.1/0001-API-Update-TDL.patch.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: BSD-3-Clause diff --git a/test/api_stability/1.1.1/0002-API-Quoted-strings-and-paths.patch b/test/api_stability/1.1.1/0002-API-Quoted-strings-and-paths.patch index 251097a3..e5338a84 100644 --- a/test/api_stability/1.1.1/0002-API-Quoted-strings-and-paths.patch +++ b/test/api_stability/1.1.1/0002-API-Quoted-strings-and-paths.patch @@ -1,7 +1,7 @@ -From a10348cbebceb4276eeb6f8832d47374fc7bfc1a Mon Sep 17 00:00:00 2001 +From 09a51343b1ee29f245eeae8210d50cd74ac9b1b4 Mon Sep 17 00:00:00 2001 From: Enrico Seiler Date: Mon, 5 Feb 2024 16:02:03 +0100 -Subject: [PATCH 2/2] [API] Quoted strings and paths +Subject: [PATCH 2/3] [API] Quoted strings and paths --- test/snippet/readme_sneak_peek.out | 6 ++--- diff --git a/test/api_stability/1.1.1/0002-API-Quoted-strings-and-paths.patch.license b/test/api_stability/1.1.1/0002-API-Quoted-strings-and-paths.patch.license new file mode 100644 index 00000000..706402f5 --- /dev/null +++ b/test/api_stability/1.1.1/0002-API-Quoted-strings-and-paths.patch.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: BSD-3-Clause diff --git a/test/api_stability/1.1.1/0003-NOAPI-Update-copyright.patch b/test/api_stability/1.1.1/0003-NOAPI-Update-copyright.patch new file mode 100644 index 00000000..3a58eaeb --- /dev/null +++ b/test/api_stability/1.1.1/0003-NOAPI-Update-copyright.patch @@ -0,0 +1,125 @@ +From 859b9d015379e0d708700225fa55dd31f7d2e2f5 Mon Sep 17 00:00:00 2001 +From: Enrico Seiler +Date: Wed, 7 Feb 2024 13:31:22 +0100 +Subject: [PATCH 3/3] [NOAPI] Update copyright + +--- + test/unit/detail/format_help_test.cpp | 10 +++++----- + test/unit/detail/format_html_test.cpp | 2 +- + test/unit/detail/format_man_test.cpp | 10 +++++----- + 3 files changed, 11 insertions(+), 11 deletions(-) + +diff --git a/test/unit/detail/format_help_test.cpp b/test/unit/detail/format_help_test.cpp +index f31e066..be31399 100644 +--- a/test/unit/detail/format_help_test.cpp ++++ b/test/unit/detail/format_help_test.cpp +@@ -135,7 +135,7 @@ TEST(help_page_printing, with_short_copyright) + + basic_options_str + "\n" + basic_version_str + "\n" + + "LEGAL\n" + " test_parser Copyright: short\n" +- " SeqAn Copyright: 2006-2023 Knut Reinert, FU-Berlin; released under the\n" ++ " SeqAn Copyright: 2006-2024 Knut Reinert, FU-Berlin; released under the\n" + " 3-clause BSDL.\n"; + EXPECT_EQ(std_cout, expected); + } +@@ -153,7 +153,7 @@ TEST(help_page_printing, with_long_copyright) + "\nOPTIONS\n\n" + + basic_options_str + "\n" + basic_version_str + "\n" + + "LEGAL\n" +- " SeqAn Copyright: 2006-2023 Knut Reinert, FU-Berlin; released under the\n" ++ " SeqAn Copyright: 2006-2024 Knut Reinert, FU-Berlin; released under the\n" + " 3-clause BSDL.\n" + " For full copyright and/or warranty information see --copyright.\n"; + EXPECT_EQ(std_cout, expected); +@@ -172,7 +172,7 @@ TEST(help_page_printing, with_citation) + "\nOPTIONS\n\n" + + basic_options_str + "\n" + basic_version_str + "\n" + + "LEGAL\n" +- " SeqAn Copyright: 2006-2023 Knut Reinert, FU-Berlin; released under the\n" ++ " SeqAn Copyright: 2006-2024 Knut Reinert, FU-Berlin; released under the\n" + " 3-clause BSDL.\n" + " In your academic works please cite: citation\n"; + EXPECT_EQ(std_cout, expected); +@@ -192,7 +192,7 @@ TEST(help_page_printing, with_author) + + basic_options_str + "\n" + basic_version_str + "\n" + + "LEGAL\n" + " Author: author\n" +- " SeqAn Copyright: 2006-2023 Knut Reinert, FU-Berlin; released under the\n" ++ " SeqAn Copyright: 2006-2024 Knut Reinert, FU-Berlin; released under the\n" + " 3-clause BSDL.\n"; + EXPECT_EQ(std_cout, expected); + } +@@ -211,7 +211,7 @@ TEST(help_page_printing, with_email) + + basic_options_str + "\n" + basic_version_str + "\n" + + "LEGAL\n" + " Contact: email\n" +- " SeqAn Copyright: 2006-2023 Knut Reinert, FU-Berlin; released under the\n" ++ " SeqAn Copyright: 2006-2024 Knut Reinert, FU-Berlin; released under the\n" + " 3-clause BSDL.\n"; + EXPECT_EQ(std_cout, expected); + } +diff --git a/test/unit/detail/format_html_test.cpp b/test/unit/detail/format_html_test.cpp +index 83c6818..6fd41d1 100644 +--- a/test/unit/detail/format_html_test.cpp ++++ b/test/unit/detail/format_html_test.cpp +@@ -199,7 +199,7 @@ TEST(html_format, full_information_information) + "
\n" + "Contact: email\n" + "
\n" +- "SeqAn Copyright: 2006-2023 Knut Reinert, FU-Berlin; released under the 3-clause BSDL.\n" ++ "SeqAn Copyright: 2006-2024 Knut Reinert, FU-Berlin; released under the 3-clause BSDL.\n" + "
\n" + "In your academic works please cite: citation\n" + "
\n" +diff --git a/test/unit/detail/format_man_test.cpp b/test/unit/detail/format_man_test.cpp +index 307b58b..eefffd6 100644 +--- a/test/unit/detail/format_man_test.cpp ++++ b/test/unit/detail/format_man_test.cpp +@@ -286,7 +286,7 @@ TEST_F(format_man_test, full_info_short_copyright) + expected += R"(.SH LEGAL + \fBdefault Copyright: \fRshort copyright + .br +-\fBSeqAn Copyright: \fR2006-2023 Knut Reinert, FU-Berlin; released under the 3-clause BSDL. ++\fBSeqAn Copyright: \fR2006-2024 Knut Reinert, FU-Berlin; released under the 3-clause BSDL. + )"; + testing::internal::CaptureStdout(); + EXPECT_EXIT(parser.parse(), ::testing::ExitedWithCode(EXIT_SUCCESS), ""); +@@ -308,7 +308,7 @@ TEST_F(format_man_test, full_info_short_and_citation) + expected += R"(.SH LEGAL + \fBdefault Copyright: \fRshort copyright + .br +-\fBSeqAn Copyright: \fR2006-2023 Knut Reinert, FU-Berlin; released under the 3-clause BSDL. ++\fBSeqAn Copyright: \fR2006-2024 Knut Reinert, FU-Berlin; released under the 3-clause BSDL. + .br + \fBIn your academic works please cite: \fRcitation + )"; +@@ -333,7 +333,7 @@ TEST_F(format_man_test, full_info_short_long_and_citation) + expected += R"(.SH LEGAL + \fBdefault Copyright: \fRshort copyright + .br +-\fBSeqAn Copyright: \fR2006-2023 Knut Reinert, FU-Berlin; released under the 3-clause BSDL. ++\fBSeqAn Copyright: \fR2006-2024 Knut Reinert, FU-Berlin; released under the 3-clause BSDL. + .br + \fBIn your academic works please cite: \fRcitation + .br +@@ -358,7 +358,7 @@ TEST_F(format_man_test, full_info_author) + expected += R"(.SH LEGAL + \fBAuthor: \fRauthor + .br +-\fBSeqAn Copyright: \fR2006-2023 Knut Reinert, FU-Berlin; released under the 3-clause BSDL. ++\fBSeqAn Copyright: \fR2006-2024 Knut Reinert, FU-Berlin; released under the 3-clause BSDL. + )"; + testing::internal::CaptureStdout(); + EXPECT_EXIT(parser.parse(), ::testing::ExitedWithCode(EXIT_SUCCESS), ""); +@@ -379,7 +379,7 @@ TEST_F(format_man_test, full_info_email) + expected += R"(.SH LEGAL + \fBContact: \fRemail + .br +-\fBSeqAn Copyright: \fR2006-2023 Knut Reinert, FU-Berlin; released under the 3-clause BSDL. ++\fBSeqAn Copyright: \fR2006-2024 Knut Reinert, FU-Berlin; released under the 3-clause BSDL. + )"; + testing::internal::CaptureStdout(); + EXPECT_EXIT(parser.parse(), ::testing::ExitedWithCode(EXIT_SUCCESS), ""); +-- +2.43.0 + diff --git a/test/api_stability/1.1.1/0003-NOAPI-Update-copyright.patch.license b/test/api_stability/1.1.1/0003-NOAPI-Update-copyright.patch.license new file mode 100644 index 00000000..706402f5 --- /dev/null +++ b/test/api_stability/1.1.1/0003-NOAPI-Update-copyright.patch.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: BSD-3-Clause diff --git a/test/api_stability/CMakeLists.txt b/test/api_stability/CMakeLists.txt index 59c4303c..d4ea949a 100644 --- a/test/api_stability/CMakeLists.txt +++ b/test/api_stability/CMakeLists.txt @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause + cmake_minimum_required (VERSION 3.8) project (api_stability) diff --git a/test/api_stability/README.md b/test/api_stability/README.md index 2ee9611f..a453fd89 100644 --- a/test/api_stability/README.md +++ b/test/api_stability/README.md @@ -1,3 +1,9 @@ + + # Sharg API Stability This test suite will check whether the current version of Sharg (e.g. git checkout) can be used to build the test cases @@ -23,13 +29,13 @@ CMAKE_BUILD_PARALLEL_LEVEL=40 cmake --build . ### How does this work? -In the following we will use `1.0.0` as the latest stable release (LSR). +In the following we will use `1.1.1` as the latest stable release (LSR). The workflow entails these steps: 1. Download and unzip the LSR. 2. Remove everything from the LSR except the tests in `/test/`. 3. Apply patches from the current git version on the LSR, i.e., patches found in - `/test/api_stability/1.0.0`. + `/test/api_stability/1.1.1`. * These patches will only apply changes on the tests. * This step is necessary as some of our tests also test non-public / non-stable API. 3. Use the current version of `find_package (Sharg)` found in `/build_system`. @@ -78,24 +84,21 @@ There are two categories of API changes that are reflected in the patches (prefi ### How to create patches? -In the following, we will use `1.0.0` as the latest stable release (LSR). +In the following, we will use `1.1.1` as the latest stable release (LSR). -Create a new branch based on the LSR and apply all existing patches in `/test/api_stability/1.0.0`. +Create a new branch based on the LSR and apply all existing patches in `/test/api_stability/1.1.1`. ``` cd -# assume that your current branch you are working on is fix_api_stability -git checkout fix_api_stability - # copy over patches to a tmp directory (`git am` seems to not support applying patches onto a different branch) mkdir -p /tmp/sharg-api-stability-patches -cp test/api_stability/1.0.0/*.patch /tmp/sharg-api-stability-patches +cp test/api_stability/1.1.1/*.patch /tmp/sharg-api-stability-patches # create a new branch based on the LSR and switch to it -git checkout -b api-stability-patches 1.0.0 +git checkout -b api-stability-patches 1.1.1 -# apply all patches onto 1.0.0 (--keep-non-patch will keep `[NOAPI]` tags in the commit message) +# apply all patches onto 1.1.1 (--keep-non-patch will keep `[NOAPI]` tags in the commit message) git am --keep-non-patch /tmp/sharg-api-stability-patches/*.patch # clean up applied patches @@ -126,8 +129,8 @@ It is also important that you double check if the patch only contains changes th After that, we can export all patches. ``` -# export all patches since 1.0.0 -git format-patch 1.0.0 +# export all patches since 1.1.1 +git format-patch 1.1.1 # move them to tmp directory mv *.patch /tmp/sharg-api-stability-patches @@ -136,14 +139,14 @@ mv *.patch /tmp/sharg-api-stability-patches Now change to your branch that you were working on and check-in the patches. ``` -git checkout fix_api_stability +git checkout - -cp /tmp/sharg-api-stability-patches/*.patch test/api_stability/1.0.0/ +cp /tmp/sharg-api-stability-patches/*.patch test/api_stability/1.1.1/ rm -rf /tmp/sharg-api-stability-patches # add new patches -git add test/api_stability/1.0.0/ +git add test/api_stability/1.1.1/ # commit changes git commit diff --git a/test/cmake/add_subdirectories.cmake b/test/cmake/add_subdirectories.cmake index 58b12ddd..2ac59911 100644 --- a/test/cmake/add_subdirectories.cmake +++ b/test/cmake/add_subdirectories.cmake @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause cmake_minimum_required (VERSION 3.10) diff --git a/test/cmake/diagnostics/list_missing_unit_tests.cmake b/test/cmake/diagnostics/list_missing_unit_tests.cmake index 5a498c22..3f7725ad 100644 --- a/test/cmake/diagnostics/list_missing_unit_tests.cmake +++ b/test/cmake/diagnostics/list_missing_unit_tests.cmake @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause cmake_minimum_required (VERSION 3.10) diff --git a/test/cmake/diagnostics/list_unused_snippets.cmake b/test/cmake/diagnostics/list_unused_snippets.cmake index 66191309..a4bbcf9e 100644 --- a/test/cmake/diagnostics/list_unused_snippets.cmake +++ b/test/cmake/diagnostics/list_unused_snippets.cmake @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause cmake_minimum_required (VERSION 3.10) diff --git a/test/cmake/diagnostics/list_unused_unit_tests.cmake b/test/cmake/diagnostics/list_unused_unit_tests.cmake index 494d1062..51b9630f 100644 --- a/test/cmake/diagnostics/list_unused_unit_tests.cmake +++ b/test/cmake/diagnostics/list_unused_unit_tests.cmake @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause cmake_minimum_required (VERSION 3.10) diff --git a/test/cmake/include_dependencies/add_include_dependencies.cmake b/test/cmake/include_dependencies/add_include_dependencies.cmake index 9ad39fb7..1f70be7d 100644 --- a/test/cmake/include_dependencies/add_include_dependencies.cmake +++ b/test/cmake/include_dependencies/add_include_dependencies.cmake @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause cmake_minimum_required (VERSION 3.10) diff --git a/test/cmake/include_dependencies/generate_include_dependencies.cmake b/test/cmake/include_dependencies/generate_include_dependencies.cmake index 03c35233..a836aaf3 100644 --- a/test/cmake/include_dependencies/generate_include_dependencies.cmake +++ b/test/cmake/include_dependencies/generate_include_dependencies.cmake @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause cmake_minimum_required (VERSION 3.12) diff --git a/test/cmake/sharg_generate_snippet.cmake b/test/cmake/sharg_generate_snippet.cmake index 3da8f957..d2f9dfb8 100644 --- a/test/cmake/sharg_generate_snippet.cmake +++ b/test/cmake/sharg_generate_snippet.cmake @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause cmake_minimum_required (VERSION 3.10) diff --git a/test/cmake/sharg_macro_benchmark.cmake b/test/cmake/sharg_macro_benchmark.cmake index 9cdcb0d3..16493575 100644 --- a/test/cmake/sharg_macro_benchmark.cmake +++ b/test/cmake/sharg_macro_benchmark.cmake @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause cmake_minimum_required (VERSION 3.10) diff --git a/test/cmake/sharg_path_longest_stem.cmake b/test/cmake/sharg_path_longest_stem.cmake index e105edab..37b718f1 100644 --- a/test/cmake/sharg_path_longest_stem.cmake +++ b/test/cmake/sharg_path_longest_stem.cmake @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause cmake_minimum_required (VERSION 3.10) diff --git a/test/cmake/sharg_require_benchmark.cmake b/test/cmake/sharg_require_benchmark.cmake index 33a8db55..737296a3 100644 --- a/test/cmake/sharg_require_benchmark.cmake +++ b/test/cmake/sharg_require_benchmark.cmake @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause cmake_minimum_required (VERSION 3.16) diff --git a/test/cmake/sharg_require_ccache.cmake b/test/cmake/sharg_require_ccache.cmake index 87f6fa41..234c038d 100644 --- a/test/cmake/sharg_require_ccache.cmake +++ b/test/cmake/sharg_require_ccache.cmake @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause cmake_minimum_required (VERSION 3.15) diff --git a/test/cmake/sharg_require_test.cmake b/test/cmake/sharg_require_test.cmake index 0caa8019..3bf30d74 100644 --- a/test/cmake/sharg_require_test.cmake +++ b/test/cmake/sharg_require_test.cmake @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause cmake_minimum_required (VERSION 3.16) diff --git a/test/cmake/sharg_test_component.cmake b/test/cmake/sharg_test_component.cmake index 87d3d087..f2116e43 100644 --- a/test/cmake/sharg_test_component.cmake +++ b/test/cmake/sharg_test_component.cmake @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause cmake_minimum_required (VERSION 3.10) diff --git a/test/cmake/sharg_test_files.cmake b/test/cmake/sharg_test_files.cmake index 73ac9e8b..7a7777b5 100644 --- a/test/cmake/sharg_test_files.cmake +++ b/test/cmake/sharg_test_files.cmake @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause cmake_minimum_required (VERSION 3.10) diff --git a/test/coverage/CMakeLists.txt b/test/coverage/CMakeLists.txt index a34e701e..34b6fd5b 100644 --- a/test/coverage/CMakeLists.txt +++ b/test/coverage/CMakeLists.txt @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause cmake_minimum_required (VERSION 3.10...3.22) project (sharg_test_coverage CXX) diff --git a/test/documentation/.vercel/README.md b/test/documentation/.vercel/README.md index 46aba9c3..f22752e0 100644 --- a/test/documentation/.vercel/README.md +++ b/test/documentation/.vercel/README.md @@ -1,3 +1,9 @@ + + How to setup vercel.com: * In vercel.com go create a new project. diff --git a/test/documentation/.vercel/build.sh b/test/documentation/.vercel/build.sh index f85b67aa..82c4b9d5 100755 --- a/test/documentation/.vercel/build.sh +++ b/test/documentation/.vercel/build.sh @@ -1,4 +1,9 @@ #!/usr/bin/env bash + +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause + set -exo pipefail SOURCE_DIR=`pwd` diff --git a/test/documentation/.vercel/index.html b/test/documentation/.vercel/index.html index aab137bf..b46a7653 100644 --- a/test/documentation/.vercel/index.html +++ b/test/documentation/.vercel/index.html @@ -1,3 +1,9 @@ + + SeqAn Documentation Preview diff --git a/test/documentation/.vercel/install.sh b/test/documentation/.vercel/install.sh index 0e2c45aa..01b5fe07 100755 --- a/test/documentation/.vercel/install.sh +++ b/test/documentation/.vercel/install.sh @@ -1,4 +1,9 @@ #!/usr/bin/env bash + +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause + set -exo pipefail DOXYGEN_VERSION=1.9.6 diff --git a/test/documentation/.vercel/powered-by-vercel.svg.license b/test/documentation/.vercel/powered-by-vercel.svg.license new file mode 100644 index 00000000..706402f5 --- /dev/null +++ b/test/documentation/.vercel/powered-by-vercel.svg.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: BSD-3-Clause diff --git a/test/documentation/.vercel/vercel.css b/test/documentation/.vercel/vercel.css index 04afab81..6ce3b63e 100644 --- a/test/documentation/.vercel/vercel.css +++ b/test/documentation/.vercel/vercel.css @@ -1,3 +1,9 @@ +/* + * SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin + * SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik + * SPDX-License-Identifier: BSD-3-Clause + */ + @media (prefers-color-scheme: dark) { :root { --background-color: black; diff --git a/test/documentation/CMakeLists.txt b/test/documentation/CMakeLists.txt index 2e54c938..cc63a0bf 100644 --- a/test/documentation/CMakeLists.txt +++ b/test/documentation/CMakeLists.txt @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause # Minimum cmake version cmake_minimum_required (VERSION 3.7) diff --git a/test/documentation/DoxygenLayout.xml.in b/test/documentation/DoxygenLayout.xml.in index 83f832ba..56040b04 100644 --- a/test/documentation/DoxygenLayout.xml.in +++ b/test/documentation/DoxygenLayout.xml.in @@ -1,3 +1,8 @@ + + diff --git a/test/documentation/README.md b/test/documentation/README.md index 15586daa..d401dd64 100644 --- a/test/documentation/README.md +++ b/test/documentation/README.md @@ -1,3 +1,9 @@ + + # sharg documentation Currently, we can only build the documentation on *nix systems. diff --git a/test/documentation/api-stability.js b/test/documentation/api-stability.js index 7b1315a9..0ac74893 100644 --- a/test/documentation/api-stability.js +++ b/test/documentation/api-stability.js @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause + /* Enrico Seiler (enrico.seiler@fu-berlin.de), 2021 */ $(document).ready(function() diff --git a/test/documentation/doc_dev/CMakeLists.txt b/test/documentation/doc_dev/CMakeLists.txt index 6acab948..96011232 100644 --- a/test/documentation/doc_dev/CMakeLists.txt +++ b/test/documentation/doc_dev/CMakeLists.txt @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause message (STATUS "Configuring devel doc.") diff --git a/test/documentation/doc_usr/CMakeLists.txt b/test/documentation/doc_usr/CMakeLists.txt index f8534f52..b7fed504 100644 --- a/test/documentation/doc_usr/CMakeLists.txt +++ b/test/documentation/doc_usr/CMakeLists.txt @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause message (STATUS "Configuring user doc.") diff --git a/test/documentation/doxygen-awesome/doxygen-awesome-darkmode-toggle.js b/test/documentation/doxygen-awesome/doxygen-awesome-darkmode-toggle.js index 40fe2d38..2f5568a3 100644 --- a/test/documentation/doxygen-awesome/doxygen-awesome-darkmode-toggle.js +++ b/test/documentation/doxygen-awesome/doxygen-awesome-darkmode-toggle.js @@ -1,3 +1,6 @@ +/* SPDX-FileCopyrightText: 2021 - 2023 jothepro + SPDX-License-Identifier: MIT +*/ /** Doxygen Awesome @@ -46,7 +49,7 @@ class DoxygenAwesomeDarkModeToggle extends HTMLElement { DoxygenAwesomeDarkModeToggle.onSystemPreferenceChanged() }) // Update the color scheme when the tab is made visible again. - // It is possible that the appearance was changed in another tab + // It is possible that the appearance was changed in another tab // while this tab was in the background. document.addEventListener("visibilitychange", visibilityState => { if (document.visibilityState === 'visible') { @@ -97,7 +100,7 @@ class DoxygenAwesomeDarkModeToggle extends HTMLElement { * @returns `true` for dark-mode, `false` for light-mode user preference */ static get userPreference() { - return (!DoxygenAwesomeDarkModeToggle.systemPreference && localStorage.getItem(DoxygenAwesomeDarkModeToggle.prefersDarkModeInLightModeKey)) || + return (!DoxygenAwesomeDarkModeToggle.systemPreference && localStorage.getItem(DoxygenAwesomeDarkModeToggle.prefersDarkModeInLightModeKey)) || (DoxygenAwesomeDarkModeToggle.systemPreference && !localStorage.getItem(DoxygenAwesomeDarkModeToggle.prefersLightModeInDarkModeKey)) } diff --git a/test/documentation/doxygen-awesome/doxygen-awesome-fragment-copy-button.js b/test/documentation/doxygen-awesome/doxygen-awesome-fragment-copy-button.js index 86c16fd9..08da4880 100644 --- a/test/documentation/doxygen-awesome/doxygen-awesome-fragment-copy-button.js +++ b/test/documentation/doxygen-awesome/doxygen-awesome-fragment-copy-button.js @@ -1,3 +1,6 @@ +/* SPDX-FileCopyrightText: 2021 - 2023 jothepro + SPDX-License-Identifier: MIT +*/ /** Doxygen Awesome @@ -47,11 +50,11 @@ class DoxygenAwesomeFragmentCopyButton extends HTMLElement { const fragmentCopyButton = document.createElement("doxygen-awesome-fragment-copy-button") fragmentCopyButton.innerHTML = DoxygenAwesomeFragmentCopyButton.copyIcon fragmentCopyButton.title = DoxygenAwesomeFragmentCopyButton.title - + fragment.parentNode.replaceChild(fragmentWrapper, fragment) fragmentWrapper.appendChild(fragment) fragmentWrapper.appendChild(fragmentCopyButton) - + } } }) diff --git a/test/documentation/doxygen-awesome/doxygen-awesome-interactive-toc.js b/test/documentation/doxygen-awesome/doxygen-awesome-interactive-toc.js index 20a9669d..4df76913 100644 --- a/test/documentation/doxygen-awesome/doxygen-awesome-interactive-toc.js +++ b/test/documentation/doxygen-awesome/doxygen-awesome-interactive-toc.js @@ -1,3 +1,6 @@ +/* SPDX-FileCopyrightText: 2021 - 2023 jothepro + SPDX-License-Identifier: MIT +*/ /** Doxygen Awesome @@ -78,4 +81,4 @@ class DoxygenAwesomeInteractiveToc { active?.classList.add("active") active?.classList.remove("aboveActive") } -} \ No newline at end of file +} diff --git a/test/documentation/doxygen-awesome/doxygen-awesome-paragraph-link.js b/test/documentation/doxygen-awesome/doxygen-awesome-paragraph-link.js index e53d132c..f5588cdb 100644 --- a/test/documentation/doxygen-awesome/doxygen-awesome-paragraph-link.js +++ b/test/documentation/doxygen-awesome/doxygen-awesome-paragraph-link.js @@ -1,3 +1,6 @@ +/* SPDX-FileCopyrightText: 2021 - 2023 jothepro + SPDX-License-Identifier: MIT +*/ /** Doxygen Awesome diff --git a/test/documentation/doxygen-awesome/doxygen-awesome-tabs.js b/test/documentation/doxygen-awesome/doxygen-awesome-tabs.js index 8e725b23..199f943d 100644 --- a/test/documentation/doxygen-awesome/doxygen-awesome-tabs.js +++ b/test/documentation/doxygen-awesome/doxygen-awesome-tabs.js @@ -1,3 +1,6 @@ +/* SPDX-FileCopyrightText: 2021 - 2023 jothepro + SPDX-License-Identifier: MIT +*/ /** Doxygen Awesome @@ -67,4 +70,4 @@ class DoxygenAwesomeTabs { }) }) } -} \ No newline at end of file +} diff --git a/test/documentation/doxygen-awesome/doxygen-awesome.css b/test/documentation/doxygen-awesome/doxygen-awesome.css index e8399cbc..4729f985 100644 --- a/test/documentation/doxygen-awesome/doxygen-awesome.css +++ b/test/documentation/doxygen-awesome/doxygen-awesome.css @@ -1,3 +1,6 @@ +/* SPDX-FileCopyrightText: 2021 - 2023 jothepro + SPDX-License-Identifier: MIT +*/ /** Doxygen Awesome @@ -204,7 +207,7 @@ html { --code-background: #2a2c2f; --tablehead-background: #2a2c2f; - + --blockquote-background: #222325; --blockquote-foreground: #7e8c92; @@ -885,7 +888,7 @@ div.header { flex-wrap: nowrap; align-items: flex-start; } - + div.contents .textblock { min-width: 200px; flex-grow: 1; @@ -977,21 +980,21 @@ html.dark-mode div.contents .dotgraph iframe h2.groupheader { border-bottom: 0px; color: var(--page-foreground-color); - box-shadow: - 100px 0 var(--page-background-color), + box-shadow: + 100px 0 var(--page-background-color), -100px 0 var(--page-background-color), 100px 0.75px var(--separator-color), -100px 0.75px var(--separator-color), - 500px 0 var(--page-background-color), + 500px 0 var(--page-background-color), -500px 0 var(--page-background-color), 500px 0.75px var(--separator-color), -500px 0.75px var(--separator-color), - 900px 0 var(--page-background-color), + 900px 0 var(--page-background-color), -900px 0 var(--page-background-color), 900px 0.75px var(--separator-color), -900px 0.75px var(--separator-color), 1400px 0 var(--page-background-color), - -1400px 0 var(--page-background-color), + -1400px 0 var(--page-background-color), 1400px 0.75px var(--separator-color), -1400px 0.75px var(--separator-color), 1900px 0 var(--page-background-color), @@ -1162,8 +1165,8 @@ div.toc li a.aboveActive { div.contents .toc.interactive > h3::before { content: ""; - width: 0; - height: 0; + width: 0; + height: 0; border-left: 4px solid transparent; border-right: 4px solid transparent; border-top: 5px solid var(--primary-color); @@ -1854,8 +1857,8 @@ table.memberdecls img[src="closed.png"], table.memberdecls img[src="open.png"], div.dynheader img[src="open.png"], div.dynheader img[src="closed.png"] { - width: 0; - height: 0; + width: 0; + height: 0; border-left: 4px solid transparent; border-right: 4px solid transparent; border-top: 5px solid var(--primary-color); @@ -1873,7 +1876,7 @@ table.memberdecls img { table.memberdecls img[src="closed.png"], div.dynheader img[src="closed.png"] { transform: rotate(-90deg); - + } .compoundTemplParams { @@ -1916,7 +1919,7 @@ div.dynheader img[src="closed.png"] { margin-bottom: calc(0px - var(--page-font-size)); } - table.memberdecls .memItemRight, + table.memberdecls .memItemRight, table.memberdecls .mdescRight, table.memberdecls .memTemplItemRight { border-top: 0; @@ -2102,8 +2105,8 @@ html.dark-mode .iconfopen, html.dark-mode .iconfclosed { background-color: transparent; } -/* - Class Index Doxygen 1.8 +/* + Class Index Doxygen 1.8 */ table.classindex { @@ -2248,7 +2251,7 @@ div.contents .toc::-webkit-scrollbar-thumb, background-color: transparent; border: var(--webkit-scrollbar-padding) solid transparent; border-radius: calc(var(--webkit-scrollbar-padding) + var(--webkit-scrollbar-padding)); - background-clip: padding-box; + background-clip: padding-box; } #nav-tree:hover::-webkit-scrollbar-thumb, @@ -2519,4 +2522,4 @@ h2:hover a.anchorlink, h1:hover a.anchorlink, h3:hover a.anchorlink, h4:hover a. html.dark-mode .tabs-overview button.tab-button:hover .tab-title { color: var(--page-foreground-color); -} \ No newline at end of file +} diff --git a/test/documentation/sharg-doxygen-package.cmake b/test/documentation/sharg-doxygen-package.cmake index dbb39798..a13b0e09 100644 --- a/test/documentation/sharg-doxygen-package.cmake +++ b/test/documentation/sharg-doxygen-package.cmake @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause cmake_minimum_required (VERSION 3.10) diff --git a/test/documentation/sharg-doxygen.cmake b/test/documentation/sharg-doxygen.cmake index 65d4c560..d7b966b7 100644 --- a/test/documentation/sharg-doxygen.cmake +++ b/test/documentation/sharg-doxygen.cmake @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause cmake_minimum_required (VERSION 3.10) diff --git a/test/documentation/sharg.css b/test/documentation/sharg.css index f2c7dd91..9ce54cba 100644 --- a/test/documentation/sharg.css +++ b/test/documentation/sharg.css @@ -1,3 +1,9 @@ +/* + * SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin + * SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik + * SPDX-License-Identifier: BSD-3-Clause + */ + /* https://jothepro.github.io/doxygen-awesome-css/md_docs_customization.html */ diff --git a/test/documentation/sharg_doxygen_cfg.in b/test/documentation/sharg_doxygen_cfg.in index 862eb45a..732df2ae 100644 --- a/test/documentation/sharg_doxygen_cfg.in +++ b/test/documentation/sharg_doxygen_cfg.in @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause + # Doxyfile 1.9.6 #--------------------------------------------------------------------------- diff --git a/test/documentation/sharg_footer.html.in b/test/documentation/sharg_footer.html.in index 895e53d1..a9e19877 100644 --- a/test/documentation/sharg_footer.html.in +++ b/test/documentation/sharg_footer.html.in @@ -1,3 +1,8 @@ + + diff --git a/test/documentation/sharg_header.html b/test/documentation/sharg_header.html index 58a75dbf..9cb7f04b 100644 --- a/test/documentation/sharg_header.html +++ b/test/documentation/sharg_header.html @@ -1,3 +1,9 @@ + + diff --git a/test/documentation/sharg_logo.svg.license b/test/documentation/sharg_logo.svg.license new file mode 100644 index 00000000..706402f5 --- /dev/null +++ b/test/documentation/sharg_logo.svg.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: BSD-3-Clause diff --git a/test/documentation/version.js b/test/documentation/version.js index b4512c93..8d6e3d33 100644 --- a/test/documentation/version.js +++ b/test/documentation/version.js @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause + /* Jongkyu Kim (j.kim@fu-berlin.de), 2016.01.12 Adaptations by Enrico Seiler (enrico.seiler@fu-berlin.de), 2020 */ diff --git a/test/documentation/version.php b/test/documentation/version.php index f0e2ade4..a5a2f489 100644 --- a/test/documentation/version.php +++ b/test/documentation/version.php @@ -1,4 +1,9 @@ int main(int argc, char ** argv) diff --git a/test/header/CMakeLists.txt b/test/header/CMakeLists.txt index e3dbfed8..07f1d444 100644 --- a/test/header/CMakeLists.txt +++ b/test/header/CMakeLists.txt @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause cmake_minimum_required (VERSION 3.12) project (sharg_header_test CXX) diff --git a/test/header/generate_header_source.cmake b/test/header/generate_header_source.cmake index 2c05b80a..e884b4ce 100644 --- a/test/header/generate_header_source.cmake +++ b/test/header/generate_header_source.cmake @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause + cmake_minimum_required (VERSION 3.10) option (HEADER_FILE_ABSOLUTE "") diff --git a/test/include/sharg/test/file_access.hpp b/test/include/sharg/test/file_access.hpp index 861187e9..fa6b61bb 100644 --- a/test/include/sharg/test/file_access.hpp +++ b/test/include/sharg/test/file_access.hpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause /*!\file * \brief Detects read and write access for a path. diff --git a/test/include/sharg/test/tmp_filename.hpp b/test/include/sharg/test/tmp_filename.hpp index f5ff5e16..1223cdcb 100644 --- a/test/include/sharg/test/tmp_filename.hpp +++ b/test/include/sharg/test/tmp_filename.hpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause /*!\file * \author Lydia Buntrock diff --git a/test/scripts/add_snippets_to_cookbook.sh b/test/scripts/add_snippets_to_cookbook.sh index 2858cb87..82cbb0b5 100755 --- a/test/scripts/add_snippets_to_cookbook.sh +++ b/test/scripts/add_snippets_to_cookbook.sh @@ -1,10 +1,7 @@ #!/usr/bin/env bash -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause # # Usage: add_snippets_to_cookbook.sh # Will update the cookbook to include all snippets of the documentation. diff --git a/test/scripts/check_markdown_doxygen.sh b/test/scripts/check_markdown_doxygen.sh new file mode 100755 index 00000000..5134a4a6 --- /dev/null +++ b/test/scripts/check_markdown_doxygen.sh @@ -0,0 +1,50 @@ +#!/usr/bin/env bash +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause +# +# Usage: check_markdown_doxygen.sh +# +# Checks that all markdown files start with a markdown header. +# This is important for Doxygen to correctly parse the markdown files. + +ANY_FAIL=0 + +do_check () +{ + IS_CORRECT=$(head -n1 "$1" | grep -c "^#" || true) + if [[ $IS_CORRECT -eq 0 ]]; then + echo 'File does not start with a markdown header:' $1 + ANY_FAIL=1 + fi +} + +if [[ $# -ne 1 ]]; then + echo "Usage: check_markdown_doxygen.sh " + exit 1 +fi + +SHARG_ROOT=$(readlink -f "$1") + +if [[ ! -d ${SHARG_ROOT} ]]; then + echo "The directory ${SHARG_ROOT} does not exist." + exit 1 +fi + +if [[ ! -f ${SHARG_ROOT}/include/sharg/version.hpp ]]; then + echo "The directory ${SHARG_ROOT} does not seem to be the Sharg root directory." + echo "Cannot find ${SHARG_ROOT}/include/sharg/version.hpp." + exit 1 +fi + +for FILE in $(find "${SHARG_ROOT}/doc" -name "*.md" -and -not -path "${SHARG_ROOT}/doc/fragments/*") +do + do_check $FILE +done + +for FILE in $(find "${SHARG_ROOT}" -maxdepth 1 -name "*.md") +do + do_check $FILE +done + +exit $ANY_FAIL diff --git a/test/scripts/link_check.sh b/test/scripts/link_check.sh index 41298d74..ae608673 100755 --- a/test/scripts/link_check.sh +++ b/test/scripts/link_check.sh @@ -1,10 +1,7 @@ #!/usr/bin/env bash -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause # # Usage: link_check.sh # Will output the status of links in the repository. diff --git a/test/scripts/update_copyright.sh b/test/scripts/update_copyright.sh index c79327bb..b6e06cf2 100755 --- a/test/scripts/update_copyright.sh +++ b/test/scripts/update_copyright.sh @@ -1,24 +1,23 @@ #!/usr/bin/env bash -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- -# + +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause + set -Eeuo pipefail usage="\ SYNOPSIS - update_copyright.sh ] []... + update_copyright.sh [] []... DESCRIPTION Updates the copyright year of files that are formatted in a certain way. And prints out the copyright years that it ignores. EXAMPLES - ./test/scripts/update_copyright.sh 2021 2022 $(find . -not -path '*/\.*' -and -not -path "./build/*" -type f) - Updates all copyright entries from 2021 to 2022. + ./test/scripts/update_copyright.sh 2024 2025 \$(find . -not -path '*/\.git/**' -and -not -path '*/submodules/*' -and -not -path '*/build/*' -and -not -iname '*.patch' -type f) + Updates all copyright entries from 2024 to 2025. Only scans non hidden directories. Does not scan build and + submodules directory. " if [ $# -eq 0 ]; then @@ -33,6 +32,6 @@ shift 2 echo "Setting copyright dates from ${oldyear} to ${year}" for file in "$@"; do - perl -i -pe 's/^(.*Copyright \(c\) [0-9]{4}-)'${oldyear}'(, Knut Reinert.*$)/${1}'${year}'${2}/' $file - perl -ne 'print "'$file':$.: $_" if (/^.*Copyright.*'${oldyear}'.*$/);' $file + perl -i -pe 's/^(.*SPDX-FileCopyrightText: [0-9]{4}-)'${oldyear}'(,? Knut Reinert.*$)/${1}'${year}'${2}/' $file + perl -ne 'print "'$file':$.: $_" if (/^.*SPDX-FileCopyrightText.*'${oldyear}'.*$/);' $file done diff --git a/test/sharg-test.cmake b/test/sharg-test.cmake index 9a136c8a..0fd558f4 100644 --- a/test/sharg-test.cmake +++ b/test/sharg-test.cmake @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause # This file provides functionality common to the different test modules used by # SeqAn3. To build tests, run cmake on one of the sub-folders in this directory diff --git a/test/snippet/CMakeLists.txt b/test/snippet/CMakeLists.txt index f8d6f17c..fc0c7f78 100644 --- a/test/snippet/CMakeLists.txt +++ b/test/snippet/CMakeLists.txt @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause cmake_minimum_required (VERSION 3.10) project (sharg_test_snippet CXX) diff --git a/test/snippet/auxiliary.cpp b/test/snippet/auxiliary.cpp index 56aa9441..c31ce3cf 100644 --- a/test/snippet/auxiliary.cpp +++ b/test/snippet/auxiliary.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include int main(int argc, char const ** argv) diff --git a/test/snippet/compare_snippet_output.cmake b/test/snippet/compare_snippet_output.cmake index 425e406d..4fbb7d50 100644 --- a/test/snippet/compare_snippet_output.cmake +++ b/test/snippet/compare_snippet_output.cmake @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: CC0-1.0 + cmake_minimum_required (VERSION 3.10) include ("${CMAKE_CURRENT_LIST_DIR}/../cmake/sharg_path_longest_stem.cmake") diff --git a/test/snippet/custom_enumeration.cpp b/test/snippet/custom_enumeration.cpp index 9c3d17fd..780b59c7 100644 --- a/test/snippet/custom_enumeration.cpp +++ b/test/snippet/custom_enumeration.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include namespace foo diff --git a/test/snippet/custom_enumeration.out.license b/test/snippet/custom_enumeration.out.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/test/snippet/custom_enumeration.out.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/test/snippet/custom_parsing_enumeration.cpp b/test/snippet/custom_parsing_enumeration.cpp index 5dc1e6e5..d3c99867 100644 --- a/test/snippet/custom_parsing_enumeration.cpp +++ b/test/snippet/custom_parsing_enumeration.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include #include diff --git a/test/snippet/custom_parsing_enumeration.out.license b/test/snippet/custom_parsing_enumeration.out.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/test/snippet/custom_parsing_enumeration.out.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/test/snippet/is_option_set.cpp b/test/snippet/is_option_set.cpp index 16086b12..c8f97225 100644 --- a/test/snippet/is_option_set.cpp +++ b/test/snippet/is_option_set.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include int main(int argc, char ** argv) diff --git a/test/snippet/is_option_set.out.license b/test/snippet/is_option_set.out.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/test/snippet/is_option_set.out.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/test/snippet/parser_1.cpp b/test/snippet/parser_1.cpp index 327c85da..3aab7a72 100644 --- a/test/snippet/parser_1.cpp +++ b/test/snippet/parser_1.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include int main(int argc, char ** argv) diff --git a/test/snippet/parser_1.out.license b/test/snippet/parser_1.out.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/test/snippet/parser_1.out.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/test/snippet/parser_2.cpp b/test/snippet/parser_2.cpp index be287378..c25bba19 100644 --- a/test/snippet/parser_2.cpp +++ b/test/snippet/parser_2.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include int main(int argc, char ** argv) diff --git a/test/snippet/parser_2.out.license b/test/snippet/parser_2.out.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/test/snippet/parser_2.out.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/test/snippet/parser_3.cpp b/test/snippet/parser_3.cpp index 5efee788..adaba78f 100644 --- a/test/snippet/parser_3.cpp +++ b/test/snippet/parser_3.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include int main(int argc, char ** argv) diff --git a/test/snippet/parser_3.out.license b/test/snippet/parser_3.out.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/test/snippet/parser_3.out.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/test/snippet/readme_sneak_peek.cpp b/test/snippet/readme_sneak_peek.cpp index f6f90572..891a094b 100644 --- a/test/snippet/readme_sneak_peek.cpp +++ b/test/snippet/readme_sneak_peek.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #define main test #include diff --git a/test/snippet/readme_sneak_peek.out.license b/test/snippet/readme_sneak_peek.out.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/test/snippet/readme_sneak_peek.out.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/test/snippet/safe_filesystem_entry.cpp b/test/snippet/safe_filesystem_entry.cpp index bc5d6fba..41910d5a 100644 --- a/test/snippet/safe_filesystem_entry.cpp +++ b/test/snippet/safe_filesystem_entry.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include #include diff --git a/test/snippet/snippet_main.cpp b/test/snippet/snippet_main.cpp index 0c87b378..a0c04b4f 100644 --- a/test/snippet/snippet_main.cpp +++ b/test/snippet/snippet_main.cpp @@ -1,2 +1,6 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + int main() {} diff --git a/test/snippet/validators_1.cpp b/test/snippet/validators_1.cpp index 5ec54539..6a8cf5e6 100644 --- a/test/snippet/validators_1.cpp +++ b/test/snippet/validators_1.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include int main(int argc, char const ** argv) diff --git a/test/snippet/validators_1.out.license b/test/snippet/validators_1.out.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/test/snippet/validators_1.out.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/test/snippet/validators_2.cpp b/test/snippet/validators_2.cpp index 037fc91c..717f5e40 100644 --- a/test/snippet/validators_2.cpp +++ b/test/snippet/validators_2.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include int main(int argc, char const ** argv) diff --git a/test/snippet/validators_2.out.license b/test/snippet/validators_2.out.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/test/snippet/validators_2.out.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/test/snippet/validators_3.cpp b/test/snippet/validators_3.cpp index c706de0c..52fff37f 100644 --- a/test/snippet/validators_3.cpp +++ b/test/snippet/validators_3.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include int main(int argc, char const ** argv) diff --git a/test/snippet/validators_3.out.license b/test/snippet/validators_3.out.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/test/snippet/validators_3.out.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/test/snippet/validators_4.cpp b/test/snippet/validators_4.cpp index afff6041..7b52dee3 100644 --- a/test/snippet/validators_4.cpp +++ b/test/snippet/validators_4.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include int main(int argc, char const ** argv) diff --git a/test/snippet/validators_4.out.license b/test/snippet/validators_4.out.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/test/snippet/validators_4.out.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/test/snippet/validators_chaining.cpp b/test/snippet/validators_chaining.cpp index 4f8e245b..bee81bac 100644 --- a/test/snippet/validators_chaining.cpp +++ b/test/snippet/validators_chaining.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include int main(int argc, char const ** argv) diff --git a/test/snippet/validators_chaining.out.license b/test/snippet/validators_chaining.out.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/test/snippet/validators_chaining.out.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/test/snippet/validators_input_directory.cpp b/test/snippet/validators_input_directory.cpp index 4babdd05..5538a2e4 100644 --- a/test/snippet/validators_input_directory.cpp +++ b/test/snippet/validators_input_directory.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include int main(int argc, char const ** argv) diff --git a/test/snippet/validators_input_directory.out.license b/test/snippet/validators_input_directory.out.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/test/snippet/validators_input_directory.out.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/test/snippet/validators_input_file.cpp b/test/snippet/validators_input_file.cpp index addd1308..426f6dea 100644 --- a/test/snippet/validators_input_file.cpp +++ b/test/snippet/validators_input_file.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include int main(int argc, char const ** argv) diff --git a/test/snippet/validators_input_file.out.license b/test/snippet/validators_input_file.out.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/test/snippet/validators_input_file.out.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/test/snippet/validators_input_file_ext_from_file.cpp b/test/snippet/validators_input_file_ext_from_file.cpp index 27c80c57..8b737e10 100644 --- a/test/snippet/validators_input_file_ext_from_file.cpp +++ b/test/snippet/validators_input_file_ext_from_file.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include #include diff --git a/test/snippet/validators_input_file_ext_from_file.err.license b/test/snippet/validators_input_file_ext_from_file.err.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/test/snippet/validators_input_file_ext_from_file.err.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/test/snippet/validators_output_directory.cpp b/test/snippet/validators_output_directory.cpp index 0f36c736..928f9dd9 100644 --- a/test/snippet/validators_output_directory.cpp +++ b/test/snippet/validators_output_directory.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include int main(int argc, char const ** argv) diff --git a/test/snippet/validators_output_directory.out.license b/test/snippet/validators_output_directory.out.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/test/snippet/validators_output_directory.out.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/test/snippet/validators_output_file.cpp b/test/snippet/validators_output_file.cpp index 80641e46..beadb18b 100644 --- a/test/snippet/validators_output_file.cpp +++ b/test/snippet/validators_output_file.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include int main(int argc, char const ** argv) diff --git a/test/snippet/validators_output_file.out.license b/test/snippet/validators_output_file.out.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/test/snippet/validators_output_file.out.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/test/snippet/validators_output_file_ext_from_file.cpp b/test/snippet/validators_output_file_ext_from_file.cpp index 41b0d5bf..98f0b966 100644 --- a/test/snippet/validators_output_file_ext_from_file.cpp +++ b/test/snippet/validators_output_file_ext_from_file.cpp @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: CC0-1.0 + #include #include diff --git a/test/snippet/validators_output_file_ext_from_file.err.license b/test/snippet/validators_output_file_ext_from_file.err.license new file mode 100644 index 00000000..b8b3e609 --- /dev/null +++ b/test/snippet/validators_output_file_ext_from_file.err.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +SPDX-License-Identifier: CC0-1.0 diff --git a/test/unit/CMakeLists.txt b/test/unit/CMakeLists.txt index fd7e1aa4..6374361c 100644 --- a/test/unit/CMakeLists.txt +++ b/test/unit/CMakeLists.txt @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause cmake_minimum_required (VERSION 3.10) project (sharg_test_unit CXX) diff --git a/test/unit/README.md b/test/unit/README.md index 0b9443a7..e42f8854 100644 --- a/test/unit/README.md +++ b/test/unit/README.md @@ -1,3 +1,9 @@ + + # API Test Here are test files for API tests, i.e. the internal functions of the app are executed with different input parameters. diff --git a/test/unit/detail/CMakeLists.txt b/test/unit/detail/CMakeLists.txt index 392f8787..2d01a802 100644 --- a/test/unit/detail/CMakeLists.txt +++ b/test/unit/detail/CMakeLists.txt @@ -1,9 +1,6 @@ -# -------------------------------------------------------------------------------------------------------- -# Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -# Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -# This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -# shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -# -------------------------------------------------------------------------------------------------------- +# SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause find_path (SHARG_TEST_LICENSE_DIR NAMES LICENSE.md diff --git a/test/unit/detail/format_ctd_test.cpp b/test/unit/detail/format_ctd_test.cpp index 965b64a1..b6d5a66f 100644 --- a/test/unit/detail/format_ctd_test.cpp +++ b/test/unit/detail/format_ctd_test.cpp @@ -1,9 +1,6 @@ -// ----------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2021, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2021, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/master/LICENSE.md -// ----------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause #include diff --git a/test/unit/detail/format_cwl_test.cpp b/test/unit/detail/format_cwl_test.cpp index 373e03a6..e1919257 100644 --- a/test/unit/detail/format_cwl_test.cpp +++ b/test/unit/detail/format_cwl_test.cpp @@ -1,9 +1,6 @@ -// ----------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2021, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2021, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/master/LICENSE.md -// ----------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause #include diff --git a/test/unit/detail/format_help_test.cpp b/test/unit/detail/format_help_test.cpp index 35c07d59..fd822461 100644 --- a/test/unit/detail/format_help_test.cpp +++ b/test/unit/detail/format_help_test.cpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause #include @@ -217,7 +214,7 @@ TEST(help_page_printing, with_short_copyright) + basic_options_str + "\n" + basic_version_str + "\n" + "LEGAL\n" " test_parser Copyright: short\n" - " SeqAn Copyright: 2006-2023 Knut Reinert, FU-Berlin; released under the\n" + " SeqAn Copyright: 2006-2024 Knut Reinert, FU-Berlin; released under the\n" " 3-clause BSDL.\n"; EXPECT_EQ(std_cout, expected); } @@ -235,7 +232,7 @@ TEST(help_page_printing, with_long_copyright) "\nOPTIONS\n\n" + basic_options_str + "\n" + basic_version_str + "\n" + "LEGAL\n" - " SeqAn Copyright: 2006-2023 Knut Reinert, FU-Berlin; released under the\n" + " SeqAn Copyright: 2006-2024 Knut Reinert, FU-Berlin; released under the\n" " 3-clause BSDL.\n" " For full copyright and/or warranty information see --copyright.\n"; EXPECT_EQ(std_cout, expected); @@ -254,7 +251,7 @@ TEST(help_page_printing, with_citation) "\nOPTIONS\n\n" + basic_options_str + "\n" + basic_version_str + "\n" + "LEGAL\n" - " SeqAn Copyright: 2006-2023 Knut Reinert, FU-Berlin; released under the\n" + " SeqAn Copyright: 2006-2024 Knut Reinert, FU-Berlin; released under the\n" " 3-clause BSDL.\n" " In your academic works please cite: citation\n"; EXPECT_EQ(std_cout, expected); @@ -274,7 +271,7 @@ TEST(help_page_printing, with_author) + basic_options_str + "\n" + basic_version_str + "\n" + "LEGAL\n" " Author: author\n" - " SeqAn Copyright: 2006-2023 Knut Reinert, FU-Berlin; released under the\n" + " SeqAn Copyright: 2006-2024 Knut Reinert, FU-Berlin; released under the\n" " 3-clause BSDL.\n"; EXPECT_EQ(std_cout, expected); } @@ -293,7 +290,7 @@ TEST(help_page_printing, with_email) + basic_options_str + "\n" + basic_version_str + "\n" + "LEGAL\n" " Contact: email\n" - " SeqAn Copyright: 2006-2023 Knut Reinert, FU-Berlin; released under the\n" + " SeqAn Copyright: 2006-2024 Knut Reinert, FU-Berlin; released under the\n" " 3-clause BSDL.\n"; EXPECT_EQ(std_cout, expected); } diff --git a/test/unit/detail/format_html_test.cpp b/test/unit/detail/format_html_test.cpp index 2b2d7e24..eadc8e02 100644 --- a/test/unit/detail/format_html_test.cpp +++ b/test/unit/detail/format_html_test.cpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause #include @@ -209,7 +206,7 @@ TEST(html_format, full_information_information) "
\n" "Contact: email\n" "
\n" - "SeqAn Copyright: 2006-2023 Knut Reinert, FU-Berlin; released under the 3-clause BSDL.\n" + "SeqAn Copyright: 2006-2024 Knut Reinert, FU-Berlin; released under the 3-clause BSDL.\n" "
\n" "In your academic works please cite: citation\n" "
\n" diff --git a/test/unit/detail/format_man_test.cpp b/test/unit/detail/format_man_test.cpp index 5e2f467e..a69a17c2 100644 --- a/test/unit/detail/format_man_test.cpp +++ b/test/unit/detail/format_man_test.cpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause #include @@ -296,7 +293,7 @@ TEST_F(format_man_test, full_info_short_copyright) expected += R"(.SH LEGAL \fBdefault Copyright: \fRshort copyright .br -\fBSeqAn Copyright: \fR2006-2023 Knut Reinert, FU-Berlin; released under the 3-clause BSDL. +\fBSeqAn Copyright: \fR2006-2024 Knut Reinert, FU-Berlin; released under the 3-clause BSDL. )"; testing::internal::CaptureStdout(); EXPECT_EXIT(parser.parse(), ::testing::ExitedWithCode(EXIT_SUCCESS), ""); @@ -318,7 +315,7 @@ TEST_F(format_man_test, full_info_short_and_citation) expected += R"(.SH LEGAL \fBdefault Copyright: \fRshort copyright .br -\fBSeqAn Copyright: \fR2006-2023 Knut Reinert, FU-Berlin; released under the 3-clause BSDL. +\fBSeqAn Copyright: \fR2006-2024 Knut Reinert, FU-Berlin; released under the 3-clause BSDL. .br \fBIn your academic works please cite: \fRcitation )"; @@ -343,7 +340,7 @@ TEST_F(format_man_test, full_info_short_long_and_citation) expected += R"(.SH LEGAL \fBdefault Copyright: \fRshort copyright .br -\fBSeqAn Copyright: \fR2006-2023 Knut Reinert, FU-Berlin; released under the 3-clause BSDL. +\fBSeqAn Copyright: \fR2006-2024 Knut Reinert, FU-Berlin; released under the 3-clause BSDL. .br \fBIn your academic works please cite: \fRcitation .br @@ -368,7 +365,7 @@ TEST_F(format_man_test, full_info_author) expected += R"(.SH LEGAL \fBAuthor: \fRauthor .br -\fBSeqAn Copyright: \fR2006-2023 Knut Reinert, FU-Berlin; released under the 3-clause BSDL. +\fBSeqAn Copyright: \fR2006-2024 Knut Reinert, FU-Berlin; released under the 3-clause BSDL. )"; testing::internal::CaptureStdout(); EXPECT_EXIT(parser.parse(), ::testing::ExitedWithCode(EXIT_SUCCESS), ""); @@ -389,7 +386,7 @@ TEST_F(format_man_test, full_info_email) expected += R"(.SH LEGAL \fBContact: \fRemail .br -\fBSeqAn Copyright: \fR2006-2023 Knut Reinert, FU-Berlin; released under the 3-clause BSDL. +\fBSeqAn Copyright: \fR2006-2024 Knut Reinert, FU-Berlin; released under the 3-clause BSDL. )"; testing::internal::CaptureStdout(); EXPECT_EXIT(parser.parse(), ::testing::ExitedWithCode(EXIT_SUCCESS), ""); diff --git a/test/unit/detail/safe_filesystem_entry_test.cpp b/test/unit/detail/safe_filesystem_entry_test.cpp index f83ebb40..72321866 100644 --- a/test/unit/detail/safe_filesystem_entry_test.cpp +++ b/test/unit/detail/safe_filesystem_entry_test.cpp @@ -1,9 +1,6 @@ -// ----------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// ----------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause #include diff --git a/test/unit/detail/seqan3_test.cpp b/test/unit/detail/seqan3_test.cpp index abe6d39b..61dce332 100644 --- a/test/unit/detail/seqan3_test.cpp +++ b/test/unit/detail/seqan3_test.cpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause #include diff --git a/test/unit/detail/type_name_as_string_test.cpp b/test/unit/detail/type_name_as_string_test.cpp index 60815250..b94a7755 100644 --- a/test/unit/detail/type_name_as_string_test.cpp +++ b/test/unit/detail/type_name_as_string_test.cpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause #include diff --git a/test/unit/detail/version_check_debug_test.cpp b/test/unit/detail/version_check_debug_test.cpp index e3ecd04d..115078cd 100644 --- a/test/unit/detail/version_check_debug_test.cpp +++ b/test/unit/detail/version_check_debug_test.cpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause #if defined(NDEBUG) # undef NDEBUG // test in debug mode diff --git a/test/unit/detail/version_check_release_test.cpp b/test/unit/detail/version_check_release_test.cpp index f207caa4..4173e137 100644 --- a/test/unit/detail/version_check_release_test.cpp +++ b/test/unit/detail/version_check_release_test.cpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause #if !defined(NDEBUG) # define NDEBUG // test in release mode diff --git a/test/unit/detail/version_check_test.hpp b/test/unit/detail/version_check_test.hpp index fe28f062..a16e040e 100644 --- a/test/unit/detail/version_check_test.hpp +++ b/test/unit/detail/version_check_test.hpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause #include diff --git a/test/unit/parser/CMakeLists.txt b/test/unit/parser/CMakeLists.txt index 6fe888b1..6d140830 100644 --- a/test/unit/parser/CMakeLists.txt +++ b/test/unit/parser/CMakeLists.txt @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause + sharg_test (enumeration_names_test.cpp) sharg_test (format_parse_test.cpp) sharg_test (format_parse_validators_test.cpp) diff --git a/test/unit/parser/enumeration_names_test.cpp b/test/unit/parser/enumeration_names_test.cpp index 8fa14608..f5276ed1 100644 --- a/test/unit/parser/enumeration_names_test.cpp +++ b/test/unit/parser/enumeration_names_test.cpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause #include diff --git a/test/unit/parser/format_parse_test.cpp b/test/unit/parser/format_parse_test.cpp index 8e5a2864..4fe1a659 100644 --- a/test/unit/parser/format_parse_test.cpp +++ b/test/unit/parser/format_parse_test.cpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause #include diff --git a/test/unit/parser/format_parse_validators_test.cpp b/test/unit/parser/format_parse_validators_test.cpp index 637bd385..46b62f84 100644 --- a/test/unit/parser/format_parse_validators_test.cpp +++ b/test/unit/parser/format_parse_validators_test.cpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause #include diff --git a/test/unit/parser/parser_design_error_test.cpp b/test/unit/parser/parser_design_error_test.cpp index 4c3406f6..308a4826 100644 --- a/test/unit/parser/parser_design_error_test.cpp +++ b/test/unit/parser/parser_design_error_test.cpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause #include diff --git a/test/unit/std/CMakeLists.txt b/test/unit/std/CMakeLists.txt index 04bcd3bd..83c79831 100644 --- a/test/unit/std/CMakeLists.txt +++ b/test/unit/std/CMakeLists.txt @@ -1,2 +1,6 @@ +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause + sharg_test (charconv_float_test.cpp) sharg_test (charconv_int_test.cpp) diff --git a/test/unit/std/charconv_float_test.cpp b/test/unit/std/charconv_float_test.cpp index 12c1ff89..0a03a016 100644 --- a/test/unit/std/charconv_float_test.cpp +++ b/test/unit/std/charconv_float_test.cpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause #include diff --git a/test/unit/std/charconv_int_test.cpp b/test/unit/std/charconv_int_test.cpp index 5e39947e..0c3221d3 100644 --- a/test/unit/std/charconv_int_test.cpp +++ b/test/unit/std/charconv_int_test.cpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause #include diff --git a/test/unit/test/CMakeLists.txt b/test/unit/test/CMakeLists.txt index 3f48fcad..541f877f 100644 --- a/test/unit/test/CMakeLists.txt +++ b/test/unit/test/CMakeLists.txt @@ -1,2 +1,6 @@ +# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin +# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik +# SPDX-License-Identifier: BSD-3-Clause + sharg_test (file_access_test.cpp) sharg_test (tmp_filename_test.cpp) diff --git a/test/unit/test/file_access_test.cpp b/test/unit/test/file_access_test.cpp index 5ec61590..9f226b28 100644 --- a/test/unit/test/file_access_test.cpp +++ b/test/unit/test/file_access_test.cpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause #include diff --git a/test/unit/test/tmp_filename_test.cpp b/test/unit/test/tmp_filename_test.cpp index a0e4317b..8a4d42eb 100644 --- a/test/unit/test/tmp_filename_test.cpp +++ b/test/unit/test/tmp_filename_test.cpp @@ -1,9 +1,6 @@ -// -------------------------------------------------------------------------------------------------------- -// Copyright (c) 2006-2023, Knut Reinert & Freie Universität Berlin -// Copyright (c) 2016-2023, Knut Reinert & MPI für molekulare Genetik -// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License -// shipped with this file and also available at: https://github.com/seqan/sharg-parser/blob/main/LICENSE.md -// -------------------------------------------------------------------------------------------------------- +// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin +// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik +// SPDX-License-Identifier: BSD-3-Clause #include