docs icon indicating copy to clipboard operation
docs copied to clipboard

[bug] Docs: Document migration ways for bunch of tools helpers

Open leha-bot opened this issue 7 months ago • 2 comments

Describe the bug

It is pretty hard to search for commits / switch between docs / google in Internet about some tools helpers. It would be better to be in conan v2 migration guide (which, I think, should be included in conan v2 docs).

The missing helpers are:

  • VisualStudioBuildEnvironment - how is better to switch it? (found some potential relevant info here: https://github.com/conan-io/conan/issues/12188#issuecomment-1326758649)
  • no_op() env helper - provide an example how to rewrite code fragment
  • tools.which() - replace to shutil.which()
  • tools.remove_files_by_mask() - tools.files.rm()

I suspect there are more examples which should be documented in migration guide too to reduce the frustration of searching...

How to reproduce it

No response

leha-bot avatar Jul 24 '25 01:07 leha-bot

Thanks for the feedback @leha-bot

I have moved this ticket to the docs repo.

VisualStudioBuildEnvironment - how is better to switch it? (found some potential relevant info here: https://github.com/conan-io/conan/issues/12188#issuecomment-1326758649)

This is not included in the migration guide, because this generator was already superseded by MSBuildToolchain and MSBuildDeps (see https://docs.conan.io/1/reference/conanfile/tools/microsoft.html) while in Conan 1, many years ago, introduced in the year 2020. So this doesn't belong necessarily to the migration guide, but there are links to the new generators in https://docs.conan.io/1/migrating_to_2.0/recipes.html#the-generate-method, and the first section explaining about the new imports.

memsharded avatar Jul 28 '25 21:07 memsharded

(Forgot to add: this issue was created when I was doing this PR)

leha-bot avatar Aug 03 '25 06:08 leha-bot