Merge pull request #6068 from grom72/pre-commit

common: add default pre-commit configuration

.github/workflows/docker_rebuild.yml

@@ -40,7 +40,7 @@ jobs:
     steps:
       - name: Clone the git repo
         uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
-  
+
       - name: Rebuild the image
         env:
           OS: ${{ matrix.OS }}

.github/workflows/pmem_ras.yml

@@ -24,7 +24,7 @@
 # utils/gha-runners/run-ras-linux.yml
 name: PMEM RAS
 
-on: 
+on:
   workflow_dispatch:
   schedule:
     # run this job every 8 hours

.github/workflows/pmem_test_matrix.yml

@@ -3,7 +3,7 @@
 # This workflow is run on 'self-hosted' runners.
 name: PMEM test matrix
 
-on: 
+on:
   workflow_call:
     inputs:
       force_enable:

.gitignore

@@ -5,6 +5,7 @@
 !.clang-format
 !.mailmap
 !.codecov.yml
+!.pre-commit-config.yml
 
 *~
 *.swp

.pre-commit-config.yml

@@ -0,0 +1,31 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright (c) 2024, Intel Corporation
+
+# You must instal pre-commit and configure your project to use it:
+# $ pip install pre-commit
+# $ pre-commit install --config .pre-commit-config.yml (in the repository root directory)
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+# Use the following command to verify that pre-commit is installed and configured properly:
+# $ pre-commit run --config ./.pre-commit-config.yml --all
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.6.0
+  hooks:
+  - id: trailing-whitespace
+    exclude: |
+      (?x)(\.match$|
+           src/test/unicode_match_script/unicodetest|
+           src/test/util_poolset_parse/pool32.set|
+           src/core/valgrind/drd.h|
+           src/core/valgrind/helgrind.h|
+           src/core/valgrind/memcheck.h|
+           src/core/valgrind/valgrind.h)
+  - id: end-of-file-fixer
+    exclude: |
+      (?x)(\.match$|
+           src/core/valgrind/memcheck.h|
+           src/test/checksum/file[0-9]|
+           ^GIT_VERSION$)
+  - id: check-yaml
+  - id: check-added-large-files

src/.clang-format

@@ -15,7 +15,6 @@ BraceWrapping:
   BeforeElse:			false
   IndentBraces:			false
 AllowShortIfStatementsOnASingleLine: false
-IndentCaseLabels: false
 AlwaysBreakAfterDefinitionReturnType: true
 SpaceBeforeParens: ControlStatements
 SpacesBeforeTrailingComments: 1

src/benchmarks/README

@@ -17,4 +17,3 @@ package.
 
 rpm-based systems : glibX-devel (where X is the API/ABI version)
 dpkg-based systems: libglibX-dev (where X is the API/ABI version)
-

src/core/pmemcore.inc

@@ -44,4 +44,3 @@ SOURCE +=\
 	$(CORE)/last_error_msg.c\
 	$(CORE)/log.c \
 	$(CORE)/log_default.c
-

src/examples/libpmem2/Makefile

@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2020-2021, Intel Corporation
+# Copyright 2019-2024, Intel Corporation
 
 #
 # examples/libpmem2/Makefile -- build the libpmem2 examples
@@ -8,4 +8,3 @@
 DIRS = advanced basic log redo map_multiple_files unsafe_shutdown ringbuf
 
 include ../Makefile.inc
-

src/examples/libpmemobj/pminvaders/.gitignore

@@ -1,3 +1,2 @@
 pminvaders
 pminvaders2
-

src/examples/libpmemobj/slab_allocator/.gitignore

@@ -1,3 +1,2 @@
 main
 libslab_allocator.so
-

src/examples/libpmemobj/string_store_tx_type/Makefile

@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2015-2016, Intel Corporation
+# Copyright 2015-2024, Intel Corporation
 
 #
 # examples/libpmemobj/string_store_tx/Makefile -- build the intro 3 example
@@ -12,4 +12,3 @@ include ../../Makefile.inc
 
 writer: writer.o
 reader: reader.o
-

src/test/ex_libpmem/Makefile

@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2015-2016, Intel Corporation
+# Copyright 2015-2024, Intel Corporation
 
 #
 # src/test/ex_libpmem/Makefile -- build ex_libpmem unittest
@@ -12,4 +12,3 @@ include ../Makefile.inc
 
 EXAMPLES=$(EX_LIBPMEM)/simple_copy \
 	$(EX_LIBPMEM)/full_copy
-

src/test/libpmempool_backup/config.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2017, Intel Corporation
+# Copyright 2017-2024, Intel Corporation
 #
 #
 # libpmempool_backup/config.sh -- test configuration
@@ -10,4 +10,3 @@
 # when run on a non-pmem file system.
 
 CONF_TIMEOUT[0]='10m'
-

src/test/obj_basic_integration/config.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2017, Intel Corporation
+# Copyright 2017-2024, Intel Corporation
 #
 #
 # obj_basic_integration/config.sh -- test configuration
@@ -10,4 +10,3 @@
 # when run on a non-pmem file system.
 
 CONF_GLOBAL_TIMEOUT='10m'
-

src/test/obj_check/Makefile

@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2015-2019, Intel Corporation
+# Copyright 2015-2024, Intel Corporation
 
 #
 # src/test/obj_check/Makefile -- build obj_check test
@@ -13,4 +13,3 @@ USE_PMEMWRITE=y
 USE_PMEMALLOC=y
 
 include ../Makefile.inc
-

src/test/obj_include/Makefile

@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2016-2019, Intel Corporation
+# Copyright 2016-2024, Intel Corporation
 
 #
 # src/test/obj_include/Makefile -- build include tests
@@ -14,4 +14,3 @@ OBJS = obj_atomic_base_include.o obj_atomic_include.o \
 LIBPMEMOBJ=y
 
 include ../Makefile.inc
-

src/test/obj_list/Makefile

@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2015-2019, Intel Corporation
+# Copyright 2015-2024, Intel Corporation
 
 #
 # src/test/obj_list/Makefile -- build obj_list test
@@ -17,4 +17,3 @@ CFLAGS += -g -DDEBUG
 LDFLAGS += $(call extract_funcs, obj_list.c)
 LDFLAGS += $(call extract_funcs, obj_list_mocks.c)
 LDFLAGS += $(call extract_funcs, obj_list_mocks_palloc.c)
-

src/test/obj_memcheck/Makefile

@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2015-2019, Intel Corporation
+# Copyright 2015-2024, Intel Corporation
 
 #
 # src/test/obj_memcheck/Makefile -- build obj_memcheck unit test
@@ -10,4 +10,3 @@ OBJS = obj_memcheck.o
 LIBPMEMOBJ=y
 
 include ../Makefile.inc
-

src/test/obj_memcheck_register/Makefile

@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2018-2019, Intel Corporation
+# Copyright 2018-2024, Intel Corporation
 
 #
 # src/test/obj_memcheck_register/Makefile -- build obj_memcheck_register test
@@ -10,4 +10,3 @@ OBJS = obj_memcheck_register.o
 LIBPMEMOBJ=y
 
 include ../Makefile.inc
-

src/test/obj_persist_count/Makefile

@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2015-2019, Intel Corporation
+# Copyright 2015-2024, Intel Corporation
 
 #
 # src/test/obj_persist_count/Makefile -- build obj_persist_count unit test
@@ -15,4 +15,3 @@ BUILD_STATIC_NONDEBUG=n
 include ../Makefile.inc
 
 LDFLAGS += $(call extract_funcs, obj_persist_count.c)
-

src/test/obj_pmemcheck/Makefile

@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2018-2019, Intel Corporation
+# Copyright 2018-2024, Intel Corporation
 
 #
 # src/test/obj_pmemcheck/Makefile -- build obj_pmemcheck unit test
@@ -10,4 +10,3 @@ OBJS = obj_pmemcheck.o
 LIBPMEMOBJ=internal-debug
 
 include ../Makefile.inc
-

src/test/obj_toid/.gitignore

@@ -1,2 +1 @@
 obj_toid
-

src/test/obj_tx_add_range/config.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2017, Intel Corporation
+# Copyright 2017-2024, Intel Corporation
 #
 #
 # obj_tx_add_range/config.sh -- test configuration
@@ -10,4 +10,3 @@
 # when run on a non-pmem file system.
 
 CONF_GLOBAL_TIMEOUT='10m'
-

src/test/obj_tx_mt/config.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2017, Intel Corporation
+# Copyright 2017-2024, Intel Corporation
 #
 #
 # obj_tx_mt/config.sh -- test configuration
@@ -10,4 +10,3 @@
 # when run on a non-pmem file system.
 
 CONF_GLOBAL_TIMEOUT='10m'
-

src/test/pmempool_check/config.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2017, Intel Corporation
+# Copyright 2017-2024, Intel Corporation
 #
 #
 # pmempool_check/config.sh -- test configuration
@@ -10,4 +10,3 @@
 # when run on a non-pmem file system.
 
 CONF_TIMEOUT[5]='10m'
-

src/test/util_map_proc/maps_align_freebsd

@@ -1,17 +1,17 @@
 00400000 0041c000 r-xp 00000000 fd:01 1310785                            /some/path/testfile
 0061b000 0061c000 rw-p 0001b000 fd:01 1310785                            /some/path/testfile
-0061c000 0061d000 rw-p 00000000 00:00 0 
+0061c000 0061d000 rw-p 00000000 00:00 0
 0081c000 0081d000 rw-p 0001c000 fd:01 1310785                            /some/path/testfile
 02699000 026ba000 rw-p 00000000 00:00 0                                  [heap]
 32b5000000 32b5020000 r-xp 00000000 fd:01 917587                         /lib64/ld-2.12.so
 32b521f000 32b5220000 r--p 0001f000 fd:01 917587                         /lib64/ld-2.12.so
 32b5220000 32b5221000 rw-p 00020000 fd:01 917587                         /lib64/ld-2.12.so
-32b5221000 32b5222000 rw-p 00000000 00:00 0 
+32b5221000 32b5222000 rw-p 00000000 00:00 0
 32b5400000 32b558b000 r-xp 00000000 fd:01 917588                         /lib64/libc-2.12.so
 32b558b000 32b578a000 ---p 0018b000 fd:01 917588                         /lib64/libc-2.12.so
 32b578a000 32b578e000 r--p 0018a000 fd:01 917588                         /lib64/libc-2.12.so
 32b578e000 32b578f000 rw-p 0018e000 fd:01 917588                         /lib64/libc-2.12.so
-32b578f000 32b5794000 rw-p 00000000 00:00 0 
+32b578f000 32b5794000 rw-p 00000000 00:00 0
 32b5c00000 32b5c02000 r-xp 00000000 fd:01 917594                         /lib64/libdl-2.12.so
 32b5c02000 32b5e02000 ---p 00002000 fd:01 917594                         /lib64/libdl-2.12.so
 32b5e02000 32b5e03000 r--p 00002000 fd:01 917594                         /lib64/libdl-2.12.so
@@ -20,7 +20,7 @@
 32b6017000 32b6217000 ---p 00017000 fd:01 917592                         /lib64/libpthread-2.12.so
 32b6217000 32b6218000 r--p 00017000 fd:01 917592                         /lib64/libpthread-2.12.so
 32b6218000 32b6219000 rw-p 00018000 fd:01 917592                         /lib64/libpthread-2.12.so
-32b6219000 32b621d000 rw-p 00000000 00:00 0 
+32b6219000 32b621d000 rw-p 00000000 00:00 0
 32b6800000 32b6807000 r-xp 00000000 fd:01 917631                         /lib64/librt-2.12.so
 32b6807000 32b6a06000 ---p 00007000 fd:01 917631                         /lib64/librt-2.12.so
 32b6a06000 32b6a07000 r--p 00006000 fd:01 917631                         /lib64/librt-2.12.so
@@ -29,7 +29,7 @@
 32b701d000 32b721c000 ---p 0001d000 fd:01 917605                         /lib64/libselinux.so.1
 32b721c000 32b721d000 r--p 0001c000 fd:01 917605                         /lib64/libselinux.so.1
 32b721d000 32b721e000 rw-p 0001d000 fd:01 917605                         /lib64/libselinux.so.1
-32b721e000 32b721f000 rw-p 00000000 00:00 0 
+32b721e000 32b721f000 rw-p 00000000 00:00 0
 32c3800000 32c3804000 r-xp 00000000 fd:01 917625                         /lib64/libattr.so.1.1.0
 32c3804000 32c3a03000 ---p 00004000 fd:01 917625                         /lib64/libattr.so.1.1.0
 32c3a03000 32c3a04000 r--p 00003000 fd:01 917625                         /lib64/libattr.so.1.1.0

src/test/util_map_proc/maps_align_linux

@@ -1,17 +1,17 @@
 00400000-0041c000 r-xp 00000000 fd:01 1310785                            /some/path/testfile
 0061b000-0061c000 rw-p 0001b000 fd:01 1310785                            /some/path/testfile
-0061c000-0061d000 rw-p 00000000 00:00 0 
+0061c000-0061d000 rw-p 00000000 00:00 0
 0081c000-0081d000 rw-p 0001c000 fd:01 1310785                            /some/path/testfile
 02699000-026ba000 rw-p 00000000 00:00 0                                  [heap]
 32b5000000-32b5020000 r-xp 00000000 fd:01 917587                         /lib64/ld-2.12.so
 32b521f000-32b5220000 r--p 0001f000 fd:01 917587                         /lib64/ld-2.12.so
 32b5220000-32b5221000 rw-p 00020000 fd:01 917587                         /lib64/ld-2.12.so
-32b5221000-32b5222000 rw-p 00000000 00:00 0 
+32b5221000-32b5222000 rw-p 00000000 00:00 0
 32b5400000-32b558b000 r-xp 00000000 fd:01 917588                         /lib64/libc-2.12.so
 32b558b000-32b578a000 ---p 0018b000 fd:01 917588                         /lib64/libc-2.12.so
 32b578a000-32b578e000 r--p 0018a000 fd:01 917588                         /lib64/libc-2.12.so
 32b578e000-32b578f000 rw-p 0018e000 fd:01 917588                         /lib64/libc-2.12.so
-32b578f000-32b5794000 rw-p 00000000 00:00 0 
+32b578f000-32b5794000 rw-p 00000000 00:00 0
 32b5c00000-32b5c02000 r-xp 00000000 fd:01 917594                         /lib64/libdl-2.12.so
 32b5c02000-32b5e02000 ---p 00002000 fd:01 917594                         /lib64/libdl-2.12.so
 32b5e02000-32b5e03000 r--p 00002000 fd:01 917594                         /lib64/libdl-2.12.so
@@ -20,7 +20,7 @@
 32b6017000-32b6217000 ---p 00017000 fd:01 917592                         /lib64/libpthread-2.12.so
 32b6217000-32b6218000 r--p 00017000 fd:01 917592                         /lib64/libpthread-2.12.so
 32b6218000-32b6219000 rw-p 00018000 fd:01 917592                         /lib64/libpthread-2.12.so
-32b6219000-32b621d000 rw-p 00000000 00:00 0 
+32b6219000-32b621d000 rw-p 00000000 00:00 0
 32b6800000-32b6807000 r-xp 00000000 fd:01 917631                         /lib64/librt-2.12.so
 32b6807000-32b6a06000 ---p 00007000 fd:01 917631                         /lib64/librt-2.12.so
 32b6a06000-32b6a07000 r--p 00006000 fd:01 917631                         /lib64/librt-2.12.so
@@ -29,7 +29,7 @@
 32b701d000-32b721c000 ---p 0001d000 fd:01 917605                         /lib64/libselinux.so.1
 32b721c000-32b721d000 r--p 0001c000 fd:01 917605                         /lib64/libselinux.so.1
 32b721d000-32b721e000 rw-p 0001d000 fd:01 917605                         /lib64/libselinux.so.1
-32b721e000-32b721f000 rw-p 00000000 00:00 0 
+32b721e000-32b721f000 rw-p 00000000 00:00 0
 32c3800000-32c3804000 r-xp 00000000 fd:01 917625                         /lib64/libattr.so.1.1.0
 32c3804000-32c3a03000 ---p 00004000 fd:01 917625                         /lib64/libattr.so.1.1.0
 32c3a03000-32c3a04000 r--p 00003000 fd:01 917625                         /lib64/libattr.so.1.1.0

src/test/util_map_proc/maps_all_freebsd

@@ -1,17 +1,17 @@
 00400000 0041c000 r-xp 00000000 fd:01 1310785                            /some/path/testfile
 0061b000 0061c000 rw-p 0001b000 fd:01 1310785                            /some/path/testfile
-0061c000 0061d000 rw-p 00000000 00:00 0 
+0061c000 0061d000 rw-p 00000000 00:00 0
 0081c000 0081d000 rw-p 0001c000 fd:01 1310785                            /some/path/testfile
 02699000 026ba000 rw-p 00000000 00:00 0                                  [heap]
 32b5000000 32b5020000 r-xp 00000000 fd:01 917587                         /lib64/ld-2.12.so
 32b521f000 32b5220000 r--p 0001f000 fd:01 917587                         /lib64/ld-2.12.so
 32b5220000 32b5221000 rw-p 00020000 fd:01 917587                         /lib64/ld-2.12.so
-32b5221000 32b5222000 rw-p 00000000 00:00 0 
+32b5221000 32b5222000 rw-p 00000000 00:00 0
 32b5400000 32b558b000 r-xp 00000000 fd:01 917588                         /lib64/libc-2.12.so
 32b558b000 32b578a000 ---p 0018b000 fd:01 917588                         /lib64/libc-2.12.so
 32b578a000 32b578e000 r--p 0018a000 fd:01 917588                         /lib64/libc-2.12.so
 32b578e000 32b578f000 rw-p 0018e000 fd:01 917588                         /lib64/libc-2.12.so
-32b578f000 32b5794000 rw-p 00000000 00:00 0 
+32b578f000 32b5794000 rw-p 00000000 00:00 0
 32b5c00000 32b5c02000 r-xp 00000000 fd:01 917594                         /lib64/libdl-2.12.so
 32b5c02000 32b5e02000 ---p 00002000 fd:01 917594                         /lib64/libdl-2.12.so
 32b5e02000 32b5e03000 r--p 00002000 fd:01 917594                         /lib64/libdl-2.12.so
@@ -20,7 +20,7 @@
 32b6017000 32b6217000 ---p 00017000 fd:01 917592                         /lib64/libpthread-2.12.so
 32b6217000 32b6218000 r--p 00017000 fd:01 917592                         /lib64/libpthread-2.12.so
 32b6218000 32b6219000 rw-p 00018000 fd:01 917592                         /lib64/libpthread-2.12.so
-32b6219000 32b621d000 rw-p 00000000 00:00 0 
+32b6219000 32b621d000 rw-p 00000000 00:00 0
 32b6800000 32b6807000 r-xp 00000000 fd:01 917631                         /lib64/librt-2.12.so
 32b6807000 32b6a06000 ---p 00007000 fd:01 917631                         /lib64/librt-2.12.so
 32b6a06000 32b6a07000 r--p 00006000 fd:01 917631                         /lib64/librt-2.12.so
@@ -29,7 +29,7 @@
 32b701d000 32b721c000 ---p 0001d000 fd:01 917605                         /lib64/libselinux.so.1
 32b721c000 32b721d000 r--p 0001c000 fd:01 917605                         /lib64/libselinux.so.1
 32b721d000 32b721e000 rw-p 0001d000 fd:01 917605                         /lib64/libselinux.so.1
-32b721e000 32b721f000 rw-p 00000000 00:00 0 
+32b721e000 32b721f000 rw-p 00000000 00:00 0
 32c3800000 32c3804000 r-xp 00000000 fd:01 917625                         /lib64/libattr.so.1.1.0
 32c3804000 32c3a03000 ---p 00004000 fd:01 917625                         /lib64/libattr.so.1.1.0
 32c3a03000 32c3a04000 r--p 00003000 fd:01 917625                         /lib64/libattr.so.1.1.0