git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 09/10] cmake (Windows): recommend using Visual Studio's built-in CMake support

From
Junio C Hamano <gitster@pobox.com>
Date
Sep 25, 2020, 18:22 UTC
Message-ID
<xmqqd029lnr3.fsf@gitster.c.googlers.com>
In-Reply-To
<f07e4216669bcda728668d8c5cc99081bfca9f49.1601044119.git.gitgitgadget@gmail.com>

"Johannes Schindelin via GitGitGadget" <gitgitgadget@gmail.com> writes:

Show 34 quoted lines
> From: Johannes Schindelin <johannes.schindelin@gmx.de>
>
> It is a lot more convenient to use than having to specify the
> configuration in CMake manually (does not matter whether using the
> command-line or CMake's GUI).
>
> Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
> ---
>  contrib/buildsystems/CMakeLists.txt | 12 +++++++++++-
>  1 file changed, 11 insertions(+), 1 deletion(-)
>
> diff --git a/contrib/buildsystems/CMakeLists.txt b/contrib/buildsystems/CMakeLists.txt
> index 1eaeb8b8e0..442b4e69ad 100644
> --- a/contrib/buildsystems/CMakeLists.txt
> +++ b/contrib/buildsystems/CMakeLists.txt
> @@ -4,7 +4,17 @@
>  
>  #[[
>  
> -Instructions to run CMake:
> +Instructions how to use this in Visual Studio:
> +
> +Open the worktree as a folder. Visual Studio 2019 and later will detect
> +the CMake configuration automatically and set everything up for you,
> +ready to build. You can then run the tests in `t/` via a regular Git Bash.
> +
> +Note: Visual Studio also has the option of opening the CMake configuration
> +directly; Using this option, Visual Studio will not find the source code,
> +though, therefore the `File>Open>Folder...` option is preferred.
> +
> +Instructions to run CMake manually:
>  
>  cmake `relative-path-to-CMakeLists.txt` -DCMAKE_BUILD_TYPE=Release
>  Eg.

Having the primary case upfront is a good idea. As we discussed, our source tree structure (especially the .gitignore we ship) only supports an separate-dir build in contrib/buildsystems/out, so we should update the "manually" part of the instruction to guide users to use the same location. Perhaps something along the line of the attached.

Also, after the post-context of the attached patch, there are mentions of Visual Studio. Please double check if they need adjustment, or more preferrably the above paragraph the patch in question added is all that is needed by Visual Studio users, in which case perhaps it would be a good idea to remove all mention of Visual Studio there to avoid sending confusing choices to the readers.

Thanks.
 contrib/buildsystems/CMakeLists.txt | 16 +++++++---------
 1 file changed, 7 insertions(+), 9 deletions(-)
diff --git a/contrib/buildsystems/CMakeLists.txt b/contrib/buildsystems/CMakeLists.txt
index 442b4e69ad..0c748949f9 100644
--- a/contrib/buildsystems/CMakeLists.txt
+++ b/contrib/buildsystems/CMakeLists.txt
@@ -16,15 +16,13 @@ though, therefore the `File>Open>Folder...` option is preferred.
 
 Instructions to run CMake manually:
 
-cmake `relative-path-to-CMakeLists.txt` -DCMAKE_BUILD_TYPE=Release
-Eg.
-From the root of git source tree
-	`cmake contrib/buildsystems/ `
-This will build the git binaries at the root
-
-For out of source builds, say build in 'git/git-build/'
-	`mkdir git-build;cd git-build; cmake ../contrib/buildsystems/`
-This will build the git binaries in git-build directory
+    mkdir -p contrib/buildsystems/out
+    cd contrib/buildsystems/out
+    cmake ../ -DCMAKE_BUILD_TYPE=Release
+
+This will build the git binaries in contrib/buildsystems/out
+directory (our top-level .gitignore file knows to ignore contents of
+this directory).
 
 Possible build configurations(-DCMAKE_BUILD_TYPE) with corresponding
 compiler flags
Previous: Johannes Schindelin via GitGitGadgetNext: Johannes Schindelin
Message 22 of 70 in “CMake and Visual Studio”
  1. 00/10 CMake and Visual StudioJohannes Schindelin via GitGitGadget, Sep 25, 2020
  2. 01/10 cmake: ignore files generated by CMake as run in Visual StudioJohannes Schindelin via GitGitGadget, Sep 25, 2020
  3. 02/10 cmake: do find Git for Windows' shell interpreterJohannes Schindelin via GitGitGadget, Sep 25, 2020
  4. Sibi SiddharthanSep 25, 2020
  5. Johannes SchindelinSep 26, 2020
  6. Đoàn Trần Công DanhSep 27, 2020
  7. Johannes SchindelinSep 28, 2020
  8. Đoàn Trần Công DanhSep 29, 2020
  9. Johannes SchindelinSep 29, 2020
  10. 03/10 cmake: ensure that the `vcpkg` packages are found on WindowsJohannes Schindelin via GitGitGadget, Sep 25, 2020
  11. 07/10 cmake (Windows): complain when encountering an unknown compilerJohannes Schindelin via GitGitGadget, Sep 25, 2020
  12. Sibi SiddharthanSep 25, 2020
  13. Johannes SchindelinSep 26, 2020
  14. 06/10 cmake (Windows): let the `.dll` files are found when running the testsJohannes Schindelin via GitGitGadget, Sep 25, 2020
  15. Eric SunshineSep 25, 2020
  16. Johannes SchindelinSep 26, 2020
  17. 05/10 cmake: quote the path accurately when editing `test-lib.sh`Johannes Schindelin via GitGitGadget, Sep 25, 2020
  18. 08/10 cmake (Windows): initialize vcpkg/build dependencies automaticallyJohannes Schindelin via GitGitGadget, Sep 25, 2020
  19. Sibi SiddharthanSep 30, 2020
  20. Johannes SchindelinSep 30, 2020
  21. 09/10 cmake (Windows): recommend using Visual Studio's built-in CMake supportJohannes Schindelin via GitGitGadget, Sep 25, 2020
  22. Junio C HamanoSep 25, 2020
  23. Johannes SchindelinSep 26, 2020
  24. 10/10 hashmap_for_each_entry(): work around MSVC's run-time check failure #3Johannes Schindelin via GitGitGadget, Sep 25, 2020
  25. Junio C HamanoSep 25, 2020
  26. Junio C HamanoSep 26, 2020
  27. Johannes SchindelinSep 26, 2020
  28. 04/10 cmake: fall back to using `vcpkg`'s `msgfmt.exe` on WindowsJohannes Schindelin via GitGitGadget, Sep 25, 2020
  29. 00/10 CMake and Visual StudioJohannes Schindelin via GitGitGadget, Sep 26, 2020
  30. 01/10 cmake: ignore files generated by CMake as run in Visual StudioJohannes Schindelin via GitGitGadget, Sep 26, 2020
  31. 05/10 cmake: quote the path accurately when editing `test-lib.sh`Johannes Schindelin via GitGitGadget, Sep 26, 2020
  32. 03/10 cmake: ensure that the `vcpkg` packages are found on WindowsJohannes Schindelin via GitGitGadget, Sep 26, 2020
  33. 04/10 cmake: fall back to using `vcpkg`'s `msgfmt.exe` on WindowsJohannes Schindelin via GitGitGadget, Sep 26, 2020
  34. 02/10 cmake: do find Git for Windows' shell interpreterJohannes Schindelin via GitGitGadget, Sep 26, 2020
  35. Øystein WalleSep 28, 2020
  36. Johannes SchindelinSep 28, 2020
  37. 10/10 hashmap_for_each_entry(): workaround MSVC's runtime check failure #3Junio C Hamano via GitGitGadget, Sep 26, 2020
  38. 09/10 cmake (Windows): recommend using Visual Studio's built-in CMake supportJohannes Schindelin via GitGitGadget, Sep 26, 2020
  39. 08/10 cmake (Windows): initialize vcpkg/build dependencies automaticallyJohannes Schindelin via GitGitGadget, Sep 26, 2020
  40. 06/10 cmake (Windows): let the `.dll` files be found when running the testsJohannes Schindelin via GitGitGadget, Sep 26, 2020
  41. 07/10 cmake (Windows): complain when encountering an unknown compilerJohannes Schindelin via GitGitGadget, Sep 26, 2020
  42. 00/11 CMake and Visual StudioJohannes Schindelin via GitGitGadget, Sep 28, 2020
  43. 01/11 cmake: ignore files generated by CMake as run in Visual StudioJohannes Schindelin via GitGitGadget, Sep 28, 2020
  44. 03/11 cmake: ensure that the `vcpkg` packages are found on WindowsJohannes Schindelin via GitGitGadget, Sep 28, 2020
  45. 02/11 cmake: do find Git for Windows' shell interpreterJohannes Schindelin via GitGitGadget, Sep 28, 2020
  46. 05/11 cmake: quote the path accurately when editing `test-lib.sh`Johannes Schindelin via GitGitGadget, Sep 28, 2020
  47. 04/11 cmake: fall back to using `vcpkg`'s `msgfmt.exe` on WindowsJohannes Schindelin via GitGitGadget, Sep 28, 2020
  48. 09/11 cmake (Windows): recommend using Visual Studio's built-in CMake supportJohannes Schindelin via GitGitGadget, Sep 28, 2020
  49. 10/11 hashmap_for_each_entry(): workaround MSVC's runtime check failure #3Junio C Hamano via GitGitGadget, Sep 28, 2020
  50. 06/11 cmake (Windows): let the `.dll` files be found when running the testsJohannes Schindelin via GitGitGadget, Sep 28, 2020
  51. 07/11 cmake (Windows): complain when encountering an unknown compilerJohannes Schindelin via GitGitGadget, Sep 28, 2020
  52. 11/11 cmake: fix typo in message when `msgfmt` was not foundJohannes Schindelin via GitGitGadget, Sep 28, 2020
  53. Junio C HamanoSep 28, 2020
  54. Johannes SchindelinSep 29, 2020
  55. 08/11 cmake (Windows): initialize vcpkg/build dependencies automaticallyJohannes Schindelin via GitGitGadget, Sep 28, 2020
  56. Sibi SiddharthanSep 29, 2020
  57. Johannes SchindelinSep 29, 2020
  58. 00/10 CMake and Visual StudioJohannes Schindelin via GitGitGadget, Sep 30, 2020
  59. 05/10 cmake: quote the path accurately when editing `test-lib.sh`Johannes Schindelin via GitGitGadget, Sep 30, 2020
  60. 04/10 cmake: fall back to using `vcpkg`'s `msgfmt.exe` on WindowsJohannes Schindelin via GitGitGadget, Sep 30, 2020
  61. 06/10 cmake (Windows): let the `.dll` files be found when running the testsJohannes Schindelin via GitGitGadget, Sep 30, 2020
  62. 07/10 cmake (Windows): complain when encountering an unknown compilerJohannes Schindelin via GitGitGadget, Sep 30, 2020
  63. 08/10 cmake (Windows): initialize vcpkg/build dependencies automaticallyJohannes Schindelin via GitGitGadget, Sep 30, 2020
  64. Johannes SchindelinSep 30, 2020
  65. Junio C HamanoSep 30, 2020
  66. 09/10 cmake (Windows): recommend using Visual Studio's built-in CMake supportJohannes Schindelin via GitGitGadget, Sep 30, 2020
  67. 10/10 hashmap_for_each_entry(): workaround MSVC's runtime check failure #3Junio C Hamano via GitGitGadget, Sep 30, 2020
  68. 02/10 cmake: do find Git for Windows' shell interpreterJohannes Schindelin via GitGitGadget, Sep 30, 2020
  69. 03/10 cmake: ensure that the `vcpkg` packages are found on WindowsJohannes Schindelin via GitGitGadget, Sep 30, 2020
  70. 01/10 cmake: ignore files generated by CMake as run in Visual StudioJohannes Schindelin via GitGitGadget, Sep 30, 2020

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.