| Message ID | c3bf266cf03a9678933623b48927ee749956218d.1622828605.git.gitgitgadget@gmail.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | Make CMake work out of the box | expand |
On Fri, Jun 4, 2021 at 1:44 PM Matthew Rogers via GitGitGadget <gitgitgadget@gmail.com> wrote: > Some users have expressed interest in a more "batteries included" way of > building via CMake[1], and a big part of that is providing easier access > to tooling external tools. > > A straightforward way to accomplish this is to make it as simple as > possible is to enable the generation of the compile_commands.json file, > which is supported by many tools such as: clang-tidy, clang-format, > sourcetrail, etc. > > This does come with a small run-time overhead during the configuration > step (~6 seconds on my machine): > [...] > This seems like a small enough price to pay to make the project more > accessible to newer users. Additionally there are other large projects > like llvm [2] which has had this enabled by default for >6 years at the > time of this writing, and no real negative consequences that I can find > with my search-skills. > > NOTE: That the comppile_commands.json is currenntly produced only when > using the Ninja and Makefile generators. See The CMake documentation[3] > for more info. s/comppile/compile/ s/currenntly/currently/ > Signed-off-by: Matthew Rogers <mattr94@gmail.com>
On Fri, Jun 4, 2021 at 11:13 PM Matthew Rogers via GitGitGadget <gitgitgadget@gmail.com> wrote: > > A straightforward way to accomplish this is to make it as simple as > possible is to enable the generation of the compile_commands.json file, > which is supported by many tools such as: clang-tidy, clang-format, > sourcetrail, etc. > > This does come with a small run-time overhead during the configuration > step (~6 seconds on my machine): > > Time to configure with CMAKE_EXPORT_COMPILE_COMMANDS=TRUE > > real 1m9.840s > user 0m0.031s > sys 0m0.031s > > Time to configure with CMAKE_EXPORT_COMPILE_COMMANDS=FALSE > > real 1m3.195s > user 0m0.015s > sys 0m0.015s > > This seems like a small enough price to pay to make the project more > accessible to newer users. Additionally there are other large projects > like llvm [2] which has had this enabled by default for >6 years at the > time of this writing, and no real negative consequences that I can find > with my search-skills. > The overhead is actually much smaller than that. In my system it is less than 150ms. The first configure takes this long because we generate command-list.h and config-list.h. This process is really slow under Windows. Thank You, Sibi Siddharthan
On Fri, Jun 4, 2021 at 5:09 PM Sibi Siddharthan <sibisiddharthan.github@gmail.com> wrote: > > On Fri, Jun 4, 2021 at 11:13 PM Matthew Rogers via GitGitGadget > <gitgitgadget@gmail.com> wrote: > > > > A straightforward way to accomplish this is to make it as simple as > > possible is to enable the generation of the compile_commands.json file, > > which is supported by many tools such as: clang-tidy, clang-format, > > sourcetrail, etc. > > > > This does come with a small run-time overhead during the configuration > > step (~6 seconds on my machine): > > > > Time to configure with CMAKE_EXPORT_COMPILE_COMMANDS=TRUE > > > > real 1m9.840s > > user 0m0.031s > > sys 0m0.031s > > > > Time to configure with CMAKE_EXPORT_COMPILE_COMMANDS=FALSE > > > > real 1m3.195s > > user 0m0.015s > > sys 0m0.015s > > > > This seems like a small enough price to pay to make the project more > > accessible to newer users. Additionally there are other large projects > > like llvm [2] which has had this enabled by default for >6 years at the > > time of this writing, and no real negative consequences that I can find > > with my search-skills. > > > > The overhead is actually much smaller than that. In my system it is > less than 150ms. Is that 150 ms for the whole process or just the difference between the two options? I'm running this on windows via the git bash provided by the git sdk. > The first configure takes this long because we generate command-list.h > and config-list.h. > This process is really slow under Windows. > I used two different build directories for both my invocations specifically to avoid having to account for cache variables and other side effects from earlier configurations. The variation could also be from network latency since in this test I was downloading vcpkg, etc. > Thank You, > Sibi Siddharthan
On Sun, Jun 6, 2021 at 4:06 AM Matt Rogers <mattr94@gmail.com> wrote: > > On Fri, Jun 4, 2021 at 5:09 PM Sibi Siddharthan > <sibisiddharthan.github@gmail.com> wrote: > > > > On Fri, Jun 4, 2021 at 11:13 PM Matthew Rogers via GitGitGadget > > <gitgitgadget@gmail.com> wrote: > > > > > > A straightforward way to accomplish this is to make it as simple as > > > possible is to enable the generation of the compile_commands.json file, > > > which is supported by many tools such as: clang-tidy, clang-format, > > > sourcetrail, etc. > > > > > > This does come with a small run-time overhead during the configuration > > > step (~6 seconds on my machine): > > > > > > Time to configure with CMAKE_EXPORT_COMPILE_COMMANDS=TRUE > > > > > > real 1m9.840s > > > user 0m0.031s > > > sys 0m0.031s > > > > > > Time to configure with CMAKE_EXPORT_COMPILE_COMMANDS=FALSE > > > > > > real 1m3.195s > > > user 0m0.015s > > > sys 0m0.015s > > > > > > This seems like a small enough price to pay to make the project more > > > accessible to newer users. Additionally there are other large projects > > > like llvm [2] which has had this enabled by default for >6 years at the > > > time of this writing, and no real negative consequences that I can find > > > with my search-skills. > > > > > > > The overhead is actually much smaller than that. In my system it is > > less than 150ms. > > Is that 150 ms for the whole process or just the difference between the two > options? I'm running this on windows via the git bash provided by the > git sdk. The difference between the two. Without exporting compile_commands.json it takes around 650ms, with it around 750ms. NOTE: This is for subsequent CMake runs. (Excludes the initial run) Thank You, Sibi Siddharthan
diff --git a/contrib/buildsystems/CMakeLists.txt b/contrib/buildsystems/CMakeLists.txt index 41320150bf66..99150c8f5853 100644 --- a/contrib/buildsystems/CMakeLists.txt +++ b/contrib/buildsystems/CMakeLists.txt @@ -58,6 +58,10 @@ else() set(USING_VCPKG FALSE) endif() +if (NOT DEFINED CMAKE_EXPORT_COMPILE_COMMANDS) + SET(CMAKE_EXPORT_COMPILE_COMMANDS TRUE) +endif() + if(USING_VCPKG) set(VCPKG_DIR "${CMAKE_SOURCE_DIR}/compat/vcbuild/vcpkg") if(NOT EXISTS ${VCPKG_DIR})