search

conan-io / conan

Conan - The open-source C and C++ package manager
https://conan.io
MIT License
8.25k stars 980 forks source link

[question] preset name != profile name #16557

Closed h-2 closed 3 months ago

h-2 commented 4 months ago

What is your question?

For my conan profile "Release" the cmake preset ends up being "conan-release", and for "Debug" it ends up being "conan-debug". This is fine! But for "DebugASAN", it also ends up being "conan-debug" and not "conan-debugasan".

Is there some easy way I can control the preset name from the profile? Or always have it be the same?

Sorry, if this has been asked before; most things I could find where outdated or referred to Conan1.

Have you read the CONTRIBUTING guide?

memsharded commented 4 months ago

Hi @h-2

Thanks for your question.

The profile file name is never used in the preset itself, if your profile file is named "Release", it is a coincidence. The presets names are taken:

So if your asan is something like an option in your profile, it should be easy to get it into the preset name, is this the case?

h-2 commented 4 months ago

Thank you for the quick reply and the explanations.

So if your asan is something like an option in your profile, it should be easy to get it into the preset name, is this the case?

Well, it changes the cxx_flags, but I wouldnt want to add those to the name...

Is there a way I can just do tools.cmake.cmake_layout:build_folder_vars = profile_name or even set it to a fixed string?

h-2 commented 4 months ago

I have tried adding:

tools.cmake.cmake_layout:build_folder_vars = [ "profile_name" ]

But it doesn't work:

conanfile.txt: ERROR: Traceback (most recent call last):
  File "/opt/prepare/corpus/.venv/lib/python3.10/site-packages/conans/client/generators/__init__.py", line 97, in write_generators
    generator.generate()
  File "/opt/prepare/corpus/.venv/lib/python3.10/site-packages/conan/tools/cmake/toolchain/toolchain.py", line 269, in generate
    write_cmake_presets(self._conanfile, toolchain, self.generator, cache_variables,
  File "/opt/prepare/corpus/.venv/lib/python3.10/site-packages/conan/tools/cmake/presets.py", line 19, in write_cmake_presets
    preset_path, preset_data = _CMakePresets.generate(conanfile, toolchain_file, generator,
  File "/opt/prepare/corpus/.venv/lib/python3.10/site-packages/conan/tools/cmake/presets.py", line 72, in generate
    data = _CMakePresets._contents(conanfile, toolchain_file, cache_variables, generator,
  File "/opt/prepare/corpus/.venv/lib/python3.10/site-packages/conan/tools/cmake/presets.py", line 98, in _contents
    conf = _CMakePresets._configure_preset(conanfile, generator, cache_variables, toolchain_file,
  File "/opt/prepare/corpus/.venv/lib/python3.10/site-packages/conan/tools/cmake/presets.py", line 115, in _configure_preset
    name = _CMakePresets._configure_preset_name(conanfile, multiconfig)
  File "/opt/prepare/corpus/.venv/lib/python3.10/site-packages/conan/tools/cmake/presets.py", line 228, in _configure_preset_name
    custom_conf, user_defined_build = get_build_folder_custom_vars(conanfile)
  File "/opt/prepare/corpus/.venv/lib/python3.10/site-packages/conan/tools/cmake/layout.py", line 84, in get_build_folder_custom_vars
    group, var = s.split(".", 1)
ValueError: not enough values to unpack (expected 2, got 1)

I am also not really sure how this is related to the layout of the build folder at all. It's just about the naming of the preset 🤔

memsharded commented 4 months ago

tools.cmake.cmake_layout:build_folder_vars = profile_name

It is not possible at this moment. Note that profile name is not even a single file, as there can be (and it is common) to use multiple profiles like -pr=profile1 -pr=profile2 -pr=profile3. This would be very challenging to implement, as the profile names are not really stored and propagated, they are evaluated very early and only the settings, options, conf values are propagating down to the recipes and CMake helpers.

The best approach for these cases is usually to abstract the concept of sanitizers, with custom settings ore options like in https://docs.conan.io/2/reference/binary_model/extending.html#extending-the-binary-model. Because the binary compatibility might be affected by them, so a explicit model of the sanitizer beyond the low level cxxflags is beneficial to manage different package_id binaries for the binaries with sanitization and binaries without. Or you don't want to manage this difference in your binaries?

memsharded commented 3 months ago

This has been closed by https://github.com/conan-io/conan/pull/16633 that allows to define any arbitrary constants in the folders and presets names, will be in Conan 2.6