add license checker #997

rbanka1 · 2024-12-17T09:31:41Z

Description

Add license checker.

Checklist

Code compiles without errors locally
All tests pass locally
CI workflows execute properly

CI workflows, not executed per PR (e.g. Nightly), execute properly
New tests added, especially if they will fail without my changes
Added/extended example(s) to cover this functionality
Extended the README/documentation
All newly added source files have a license
All newly added source files are referenced in CMake files
Logger (with debug/info/... messages) is used

src/base_alloc/base_alloc_global.c

check_license/check-headers.sh

CMakeLists.txt

.github/workflows/reusable_checks.yml

check_license/check-headers.sh

scripts/docs_config/conf.py

.github/workflows/reusable_checks.yml

check_license/check-headers.sh

check_license/file-exceptions.sh

lukaszstolarczuk · 2024-12-19T13:13:34Z

check_license/file-exceptions.sh

+# Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+# You can add an exception file


is this exception list for license check or for copyright check? or both? please mention it in the comment here

it is for both

as I stated above - please mention it in the comment here

check_license/file-exceptions.sh

lukaszstolarczuk · 2024-12-19T13:22:01Z

check_license/check-headers.sh

@@ -0,0 +1,192 @@
+#!/usr/bin/env bash


when all done, the last thing to do would be to make order in your commits. In this PR it would be at best to have 3 commits:

adding check_license based on the pmemstream repository (with link in the description ,where was it copied from)

adding all your changes to the script

fixing copyrights and licenses

ok, so this is not done ideally - a few notes on commits:

still there are 4 commits - the last one, with simple fixes should be squashed, for sure

descriptions of the commits should be as meaningful as possible; e.g. now, the second one ([Fix formatting of CMakeLists.txt](https://github.com/oneapi-src/unified-memory-framework/pull/997/commits/d8ba0f40dc48ec80eff8e8836d13bf642c780f00)) have a lot of lines, which are not relevant... and the title is inaccurate

the title Final version of license check is also not saying what you did in this commit 😉

in case you need any hint on this matter, please let me, or anyone else from the team know and we'll gladly help

check_license/check-headers.sh

Fix formatting of CMakeLists.txt V2 Check license Check license V2 Check license V2.2 Check license V2.3 Check license V2.3 false test Check license V2.3 false test 2 Check license V2.3 false test 3 Check license V2.3 false test 4 TEST v1 TEST v1.2 TEST v1.3 TEST v1.4 Fix V1 Add date exception Added more exception files Added more exception files V2 Added more exception files V2.2 final version final version v2 final version v3

Final version of license check.. Final version of license check... Final version of license check....

lukaszstolarczuk · 2024-12-20T14:37:38Z

.github/workflows/sanitizers.yml

@@ -0,0 +1,142 @@
+# Check code with compilers' sanitizers
+name: Sanitizers


heh, this file shouldn't be here

lukaszstolarczuk · 2024-12-20T14:39:13Z

check_license/check-headers.sh

@@ -0,0 +1,192 @@
+#!/usr/bin/env bash


ok, so this is not done ideally - a few notes on commits:

still there are 4 commits - the last one, with simple fixes should be squashed, for sure

descriptions of the commits should be as meaningful as possible; e.g. now, the second one ([Fix formatting of CMakeLists.txt](https://github.com/oneapi-src/unified-memory-framework/pull/997/commits/d8ba0f40dc48ec80eff8e8836d13bf642c780f00)) have a lot of lines, which are not relevant... and the title is inaccurate

the title Final version of license check is also not saying what you did in this commit 😉

in case you need any hint on this matter, please let me, or anyone else from the team know and we'll gladly help

check_license/check-headers.sh

lukaszstolarczuk · 2024-12-20T14:41:36Z

check_license/file-exceptions.sh

+# Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+# You can add an exception file


as I stated above - please mention it in the comment here

includes: - add missing CUDA provider in the web docs, - proxy_pool is enabled by default, move req. info to proxy_lib, - add links in README.

and update the script to work outside of scripts dir.

Signed-off-by: Lukasz Dorau <[email protected]>

…est_valgrind.sh Fix paths of logs in test_valgrind.sh

Set device_properties.stype during init. Found by L0 validation layer.

Fix L0 provider

…n_examples enable building examples on win static hwloc CI

Update docs content and process

lukaszstolarczuk · 2025-01-03T13:56:48Z

check_license/file-exceptions.sh

+grep -v -E -e 'src/uthash/.*' \
+           -e 'benchmark/ubench.h' \
+           -e 'include/umf/proxy_lib_new_delete.h' \
+           -e 'scripts/docs_config/conf.py' \


docs files moved to a new <umf_root>/docs dir, so at least this line should be updated

lukaszstolarczuk · 2025-01-03T13:57:30Z

check_license/file-exceptions.sh

+           -e '\.cmake-format$' \
+           -e 'CODEOWNERS$' \
+           -e 'scripts/assets/images/.*' \
+           -e 'scripts/docs_config/.*' \


hmm I think not all files from docs_config (now called docs/config) should be omitted

based on https://github.com/pmem/pmemstream/tree/master/utils/check_license

updated checker algoritm, added exception files, added correct license where needed, added calling checker

lukaszstolarczuk · 2025-01-09T11:17:07Z

continued in #1028

add license checker

d90e3d4

lukaszstolarczuk reviewed Dec 17, 2024

View reviewed changes

rbanka1 force-pushed the rb_checkLicense branch from 1846102 to f81e20f Compare December 17, 2024 12:55

lukaszstolarczuk reviewed Dec 17, 2024

View reviewed changes

check_license/check-headers.sh Outdated Show resolved Hide resolved

check_license/check-headers.sh Outdated Show resolved Hide resolved

lukaszstolarczuk reviewed Dec 18, 2024

View reviewed changes

scripts/docs_config/conf.py Outdated Show resolved Hide resolved

lukaszstolarczuk requested changes Dec 19, 2024

View reviewed changes

rbanka1 force-pushed the rb_checkLicense branch from 41d276d to d27f555 Compare December 20, 2024 11:29

rbanka1 force-pushed the rb_checkLicense branch from d27f555 to d8ba0f4 Compare December 20, 2024 12:04

rbanka1 added 2 commits December 20, 2024 13:11

Final version of license check

3622820

Final version of license check.

c6a9fa0

Final version of license check.. Final version of license check... Final version of license check....

rbanka1 force-pushed the rb_checkLicense branch from 0660a85 to c6a9fa0 Compare December 20, 2024 13:06

rbanka1 marked this pull request as ready for review December 20, 2024 13:34

rbanka1 requested a review from a team as a code owner December 20, 2024 13:34

rbanka1 requested a review from lukaszstolarczuk December 20, 2024 13:35

lukaszstolarczuk reviewed Dec 20, 2024

View reviewed changes

lukaszstolarczuk and others added 12 commits December 23, 2024 16:27

Minor cleanups and additions in docs

e83ee34

includes: - add missing CUDA provider in the web docs, - proxy_pool is enabled by default, move req. info to proxy_lib, - add links in README.

Move docs content into a separate dir

718c61d

and update the script to work outside of scripts dir.

[CMake] Add 'docs' target

78d2798

[CI] make docs workflow reusable in deploy job

c7fdc11

Fix paths of logs in test_valgrind.sh

70c5906

Signed-off-by: Lukasz Dorau <[email protected]>

Merge pull request oneapi-src#1014 from ldorau/Fix_paths_of_logs_in_t…

cf98482

…est_valgrind.sh Fix paths of logs in test_valgrind.sh

Fix L0 provider

5844c5a

Set device_properties.stype during init. Found by L0 validation layer.

Merge pull request oneapi-src#1015 from igchor/stype_fix_l0

71055de

Fix L0 provider

enable building examples on win static hwloc CI

58ba8e9

fix setting LIBHWLOC_LIBRARIES on Windows

91f14d7

Merge pull request oneapi-src#1016 from bratpiorka/rrudnick_enable_wi…

9dd2283

…n_examples enable building examples on win static hwloc CI

Merge pull request oneapi-src#999 from lukaszstolarczuk/docs-change

30fada6

Update docs content and process

lukaszstolarczuk reviewed Jan 3, 2025

View reviewed changes

add license checker

e82e88f

based on https://github.com/pmem/pmemstream/tree/master/utils/check_license

rbanka1 added 3 commits January 7, 2025 11:55

Update license checker

86933e6

updated checker algoritm, added exception files, added correct license where needed, added calling checker

Updated dates

90ec139

Updated dates

937359a

lukaszstolarczuk closed this Jan 9, 2025

rbanka1 deleted the rb_checkLicense branch January 14, 2025 15:57

		@@ -0,0 +1,142 @@
		# Check code with compilers' sanitizers
		name: Sanitizers

add license checker #997

add license checker #997

Uh oh!

Conversation

rbanka1 commented Dec 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lukaszstolarczuk commented Jan 9, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

rbanka1 commented Dec 17, 2024 •

edited

Loading