From: Maxim Kokryashkin via Tarantool-patches <tarantool-patches@dev.tarantool.org> To: "Sergey Bronnikov" <estetus@gmail.com> Cc: max.kokryashkin@gmail.com, tarantool-patches@dev.tarantool.org Subject: Re: [Tarantool-patches] [PATCH luajit 3/4][v2] cmake: introduce target with codespell Date: Thu, 12 Oct 2023 13:43:49 +0300 [thread overview] Message-ID: <1697107429.603761776@f747.i.mail.ru> (raw) In-Reply-To: <0f1c6ed9f0bdade86631edc135839e607f3bb7f6.1697042800.git.sergeyb@tarantool.org> [-- Attachment #1: Type: text/plain, Size: 3920 bytes --] Hi, Sergey! Please consider my comments below. >Среда, 11 октября 2023, 19:54 +03:00 от Sergey Bronnikov via Tarantool-patches <tarantool-patches@dev.tarantool.org>: > >From: Sergey Bronnikov < sergeyb@tarantool.org > > >The patch introduces a new CMake target: "LuaJIT-codespell", that >spellchecks files specified in a whitelist by codespell [1]. Typo: s/a whitelist/the whitelist/ > >1. https://github.com/codespell-project/codespell >--- > CMakeLists.txt | 1 + > cmake/CodeSpell.cmake | 36 ++++++++++++++++++++++++++++++++ > test/CMakeLists.txt | 1 + > tools/codespell-ignore-words.txt | 3 +++ > 4 files changed, 41 insertions(+) > create mode 100644 cmake/CodeSpell.cmake > create mode 100644 tools/codespell-ignore-words.txt > >diff --git a/CMakeLists.txt b/CMakeLists.txt >index eebf3d6f..7ef10f2f 100644 >--- a/CMakeLists.txt >+++ b/CMakeLists.txt >@@ -32,6 +32,7 @@ set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake") > include(LuaJITUtils) > include(SetBuildParallelLevel) > include(SetVersion) >+include(CodeSpell) > > # --- Variables to be exported to child scopes --------------------------------- > >diff --git a/cmake/CodeSpell.cmake b/cmake/CodeSpell.cmake >new file mode 100644 >index 00000000..c4d3555d >--- /dev/null >+++ b/cmake/CodeSpell.cmake >@@ -0,0 +1,36 @@ >+find_program(CODESPELL codespell) >+ >+list(APPEND CODESPELL_WHITELIST ${PROJECT_SOURCE_DIR}/src/lj_mapi.c) >+list(APPEND CODESPELL_WHITELIST ${PROJECT_SOURCE_DIR}/src/lj_sysprof.c) >+list(APPEND CODESPELL_WHITELIST ${PROJECT_SOURCE_DIR}/src/lj_utils_leb128.c) >+list(APPEND CODESPELL_WHITELIST ${PROJECT_SOURCE_DIR}/src/lj_wbuf.c) >+list(APPEND CODESPELL_WHITELIST ${PROJECT_SOURCE_DIR}/src/luajit-gdb.py) >+list(APPEND CODESPELL_WHITELIST ${PROJECT_SOURCE_DIR}/src/luajit_lldb.py) >+list(APPEND CODESPELL_WHITELIST ${PROJECT_SOURCE_DIR}/test/CMakeLists.txt) >+list(APPEND CODESPELL_WHITELIST ${PROJECT_SOURCE_DIR}/test/tarantool-c-tests) >+list(APPEND CODESPELL_WHITELIST ${PROJECT_SOURCE_DIR}/test/tarantool-tests) >+list(APPEND CODESPELL_WHITELIST ${PROJECT_SOURCE_DIR}/tools) CMake’s list is variadic, you can add all entries in one go. >+ >+set(IGNORE_WORDS ${PROJECT_SOURCE_DIR}/tools/codespell-ignore-words.txt) >+ >+add_custom_target(${PROJECT_NAME}-codespell) >+if (CODESPELL) >+ add_custom_command(TARGET ${PROJECT_NAME}-codespell >+ COMMENT "Running codespell" >+ COMMAND >+ ${CODESPELL} >+ --ignore-words ${IGNORE_WORDS} >+ --skip ${IGNORE_WORDS} >+ --ignore-words-list fpr >+ --check-filenames >+ ${CODESPELL_WHITELIST} >+ WORKING_DIRECTORY ${PROJECT_SOURCE_DIR} >+ ) >+else () >+ set(WARN_MSG "`codespell' is not found, " >+ "so ${PROJECT_NAME}-codespell target is dummy") >+ add_custom_command(TARGET ${PROJECT_NAME}-codespell >+ COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --red ${MSG} >+ COMMENT ${MSG} Why a `message` call with level set to WARNING is not enough? Is there a concern about coloring? If so, I believe it’s inconsistent to use approach with cmake_echo_color. In case of `prove` absence on the machine, the more important message about skipped regression tests will be less noticeable in comparison with codespell, which is by far less important. >+ ) >+endif (CODESPELL) >diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt >index 58cba5ba..8afc42df 100644 >--- a/test/CMakeLists.txt >+++ b/test/CMakeLists.txt >@@ -68,6 +68,7 @@ endif() > add_custom_target(${PROJECT_NAME}-lint DEPENDS > ${PROJECT_NAME}-luacheck > ${PROJECT_NAME}-flake8 >+ ${PROJECT_NAME}-codespell > ) > > set(LUAJIT_TEST_COMMAND "${LUAJIT_TEST_BINARY} -e dofile[[${LUAJIT_TEST_INIT}]]") >diff --git a/tools/codespell-ignore-words.txt b/tools/codespell-ignore-words.txt >new file mode 100644 >index 00000000..ceeed47c >--- /dev/null >+++ b/tools/codespell-ignore-words.txt >@@ -0,0 +1,3 @@ >+mmaped >+isnt >+FPR >-- >2.34.1 -- Best regards, Maxim Kokryashkin [-- Attachment #2: Type: text/html, Size: 5265 bytes --]
next prev parent reply other threads:[~2023-10-12 10:43 UTC|newest] Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top 2023-10-11 16:52 [Tarantool-patches] [PATCH luajit 0/4][v2] Fix typos and enable codespell Sergey Bronnikov via Tarantool-patches 2023-10-11 16:52 ` [Tarantool-patches] [PATCH luajit 1/4][v2] codehealth: fix typos Sergey Bronnikov via Tarantool-patches 2023-10-12 10:33 ` Maxim Kokryashkin via Tarantool-patches 2023-10-23 8:50 ` Sergey Kaplun via Tarantool-patches 2023-10-11 16:52 ` [Tarantool-patches] [PATCH luajit 2/4][v2] test: fix codestyle Sergey Bronnikov via Tarantool-patches 2023-10-12 10:34 ` Maxim Kokryashkin via Tarantool-patches 2023-10-23 8:52 ` Sergey Kaplun via Tarantool-patches 2023-10-23 14:13 ` Sergey Bronnikov via Tarantool-patches 2023-10-23 14:27 ` Sergey Kaplun via Tarantool-patches 2023-10-11 16:52 ` [Tarantool-patches] [PATCH luajit 3/4][v2] cmake: introduce target with codespell Sergey Bronnikov via Tarantool-patches 2023-10-11 19:33 ` Sergey Bronnikov via Tarantool-patches 2023-10-12 10:43 ` Maxim Kokryashkin via Tarantool-patches [this message] 2023-10-12 13:28 ` Sergey Bronnikov via Tarantool-patches 2023-10-12 18:46 ` Maxim Kokryashkin via Tarantool-patches 2023-10-17 14:50 ` Sergey Bronnikov via Tarantool-patches 2023-10-23 9:20 ` Sergey Kaplun via Tarantool-patches 2023-10-23 12:29 ` Sergey Bronnikov via Tarantool-patches 2023-10-23 14:38 ` Sergey Kaplun via Tarantool-patches 2023-10-31 6:42 ` Sergey Kaplun via Tarantool-patches 2023-10-31 10:50 ` Sergey Bronnikov via Tarantool-patches 2023-10-31 11:31 ` Sergey Kaplun via Tarantool-patches 2023-10-31 11:53 ` Maxim Kokryashkin via Tarantool-patches 2023-10-11 16:52 ` [Tarantool-patches] [PATCH luajit 4/4][v2] ci: enable codespell Sergey Bronnikov via Tarantool-patches 2023-10-12 10:45 ` Maxim Kokryashkin via Tarantool-patches 2023-10-23 8:53 ` Sergey Kaplun via Tarantool-patches 2023-11-16 16:19 ` [Tarantool-patches] [PATCH luajit 0/4][v2] Fix typos and " Igor Munkin via Tarantool-patches
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=1697107429.603761776@f747.i.mail.ru \ --to=tarantool-patches@dev.tarantool.org \ --cc=estetus@gmail.com \ --cc=m.kokryashkin@tarantool.org \ --cc=max.kokryashkin@gmail.com \ --subject='Re: [Tarantool-patches] [PATCH luajit 3/4][v2] cmake: introduce target with codespell' \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: link
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox