musescore/MuseScore

Suggestion: Compile Instructions guide step to disable CMakePresets if not already done

Open

#16,424 opened on 2023年2月17日

GitHub で見る
 (4 comments) (0 reactions) (0 assignees)C++ (11,122 stars) (2,432 forks)batch import
communitydocumentationgood first issue

説明

Describe the bug

Not a bug but more of a small suggestion for the compile instructions guide to make things easier for less experienced developers. While following the compile instructions I ran into an issue at step 2.1 'Standard Build' where I was expecting CMake to generate a msvc.build_x64 folder in the checkout directory but this was not being generated. I eventually figured out that because I have a recent fresh install of Visual Studio I had a CMake option enabled which automatically generates a CMakePresets.json file which was causing VS to ignore the CMakeSettings.json file.

I think it would be helpful for those not so familiar with CMake to mention that this might happen and suggest to check CMake settings in VS. Something small like 'In the event that msvc.build_x64 is not generating in the checkout directory (root), be sure to check that Visual Studio is correctly picking up the x64-RelWithDebInfo configuration and not one of the default Visual Studio configurations'.

To Reproduce

Steps to reproduce the behavior:

  1. Open Visual Studio
  2. Click on tools
  3. Click on options
  4. Click on CMake in the dropdown menu on the left
  5. Click on General
  6. Under 'CMake configuration file' select 'Always use CMake Presets'
  7. Follow the Compile Instructions from the beginning under the assumption that there is no existing knowledge of this setting. (I believe it is the default in Visual Studio).

Expected behavior

I think this is probably pretty obvious for more experienced developers but as a newbie to C++ build tools, I was expecting to follow the Compile Instructions guide and for the msvc.build_x64 folder to get generated without having to change any settings in Visual Studio itself. Simple enough to solve but it might save someone else a bit of time.

Screenshots

With the following setting selected:

mscore_visualstudio_incorrect_setting

Visual Studio generates a file called 'CMakePresets.json' and will try to build for the default VS x64Debug or another default option:

mscore_visualstudio_CMakePresets

Changing the setting to 'Never use CMake Presets ':

mscore_visualstudio_correct_setting

Now the correct build configuration is selected and CMake will correctly generate the msvc.build_x64 folder.

mscore_correct

Platform information

  • OS: Windows 11

Additional context Visual Studio 17 2022

コントリビューターガイド

技術スタック
cpp
領域
documentationdeveloper experience
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
basic CMake knowledge
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
75
調査方針
The issue proposes adding a note to the compile instructions for Windows (https://musescore.org/en/handbook/developers handbook/compilation/compile instructions windows visual studio#2.1 Standard build) to check that Visual Studio's CMakePresets option is disabled ('Never use CMake Presets') to ensure the msvc.build x64 folder is generated. The fix would involve editing the documentation to include a step or tip about this setting, referencing the path: Tools > Options > CMake > General > CMake configuration file. The images provided in the issue illustrate the correct and incorrect settings.