docs: v2 migration guidence for `conf_info` #13490

prince-chrismc · 2022-10-14T20:56:03Z

Docs!

This came up in #12896
and in #13429

I've read the guidelines for contributing.
I've followed the PEP8 style guides for Python code in the recipes.
I've used the latest Conan client version.
I've tried at least one configuration locally with the conan-center hook activated.

SSE4 · 2022-10-15T08:04:27Z

docs/v2_migration.md

+The [2.0 migrations docs](https://docs.conan.io/en/latest/migrating_to_2.0/recipes.html#removed-self-user-info)
+should over the technical details however for ConanCenterIndex we need to make sure there are no collisions
+`conf_info` must be named `user.<recipe_name>:<variable>`.
+


an example would be nice to have here,
e.g. we have:

conan-center-index/recipes/gnu-config/all/conanfile.py

Lines 53 to 54 in ce23ad7

self.user_info.CONFIG_GUESS = os.path.join(bin_path, "config.guess")

self.user_info.CONFIG_SUB = os.path.join(bin_path, "config.sub")

+

conan-center-index/recipes/libdaemon/all/conanfile.py

Lines 76 to 79 in 83a3d33

shutil.copy(self._user_info_build["gnu-config"].CONFIG_SUB,

os.path.join(self._source_subfolder, "config.sub"))

shutil.copy(self._user_info_build["gnu-config"].CONFIG_GUESS,

os.path.join(self._source_subfolder, "config.guess"))

what's the direct replacement?

Yes, I've been seeing a lot of V2 recipe updates which use gnu-config's user_info items. It would be great to provide an example of how to do it and upgrade the gnu-config recipe at the same time.

Are the Conan doc examples not clear?

unfortunately, they are not very clear...
specifically, that part:

def generate(self): my_value = self.dependencies[pkg].conf_info.get("user.myconf:foo")

what is pkg here? is it just "pkg" or "pkg/1.0" or something else?

is it only possible to access in generate method? we at least need in build

user.myconf:foo is too vague/abstract. can I just write self.conf_info.define("CONFIG_SUB", "config.sub"), or does it need to be self.conf_info.define("user.CONFIG_SUB", "config.sub"), or self.conf_info.define("user:CONFIG_SUB", "config.sub") or self.conf_info.define("user.CONFIG_SUB:CONFIG_SUB", "config.sub")? it's not fully clear which parts of the syntax user.myconf:foo are mandatory or optional... and if user is somehow special or e.g. gnu-config can be used instead of user namespace?

Conan docs is good, but too generic. I see no problem adding a more specific example case in CCI docs.

There's a boat load of discussion around should we even add this #12896

And I asked Space to stick it in a PR to make sure it works https://github.com/conan-io/conan-center-index/pull/13581/files#r998575640.

I added a smaller example + captured some of the outside conversations. let me know if thats good!

docs/v2_migration.md

jwillikers · 2022-10-15T12:58:56Z

docs/v2_migration.md

+The [2.0 migrations docs](https://docs.conan.io/en/latest/migrating_to_2.0/recipes.html#removed-self-user-info)
+should over the technical details however for ConanCenterIndex we need to make sure there are no collisions
+`conf_info` must be named `user.<recipe_name>:<variable>`.
+


Yes, I've been seeing a lot of V2 recipe updates which use gnu-config's user_info items. It would be great to provide an example of how to do it and upgrade the gnu-config recipe at the same time.

Co-authored-by: Jordan Williams <jordan@jwillikers.com>

prince-chrismc · 2022-10-17T22:28:49Z

there's a conversation if we should even be using them #12896

As descibed in conan-io#13490 Applies code-review comments

As described in conan-io#13490 Added a fixme note to the user_info entries, I also kept these conf_info, Such that downstream projects which relied on the `user_info` can migrate to `conf_info`.

* autoconf v2 ready Note: test_package can't use the new Autools generator due to conan-io/conan#11975 * Revert removal of PATH from env_info From review comment * use unix_path instead of private import functions According review comment * use unix_path instead of private import functions According review comment * pass self to unix_path * applied review comments KB-H013 states that everything needs to be installed under bin for tools. This also means that the `PATH` for the actual bin location `bin/bin` needs to be added to the `build_env` * Add licenses to package * Explicitly use an empty includedirs Should fix KB-H071 * Fix setting unix_path for package_info subsystem isn't known at this time * simplified test_package No need to actually compile something with this tool we simply need to know if it runs. The win_bash for the run needs to be set explicitly due to the conf not working properly in the test_package see conan-io/conan#11975 * Revert "simplified test_package" This reverts commit d9ee4de. * use modern tools in test_package * add conan test_v1_package * m4 is a build requirement * Ducktype Autotools `configure` and `make` This allows us to use the msys2 bash without using the conf_info in the test_package. Which is currently problematic due to: conan-io/conan#11975 Contributes to CURA-9574 * Fix paths on windows in test method Contributes to CURA-8831 * Don't ducktype but inherit The ducktyping seems to affect the usage of the Autotools in the main recipe as well Contributes to CURA-8831 * use unix_path for env_info Contributes to CURA-8831 * remove extra lin Contributes to CURA-8831 * don't use unix_path The subsystem isn't known when consuming projects request the info Contributes to CURA-8831 * fix subsystems on Windows Using some duck typing and inheritance to work around GH issue conan-io/conan#11980 Contributes to CURA-9595 * updated autoconf for conan v2 ready support Contribute to CURA-8831 * autoconf bin contains shell scripts not executable Contribute to CURA-8831 * Removed Autotools workaround from test_package Still an issue: conan-io/conan#11975 Contribute to CURA-8831 * m4 is a run requirement not a tool_req Contribute to CURA-8831 * use mingw32 for gnu tuple version 2.69 doesn't known mingw64, it should hold no difference for the end result. Contribute to CURA-8831 * Run the configure command in the build_folder Contributes to CURA-8831 * Use conanbuild env as scope for testing Contribute to CURA-8831 * Ensure that M4 binary from dependency is used Contributes to CURA-8831 * Set win_bash in configure stage Contributes to CURA-8831 * Move conf keys to user space Applies code-review comments * Use *_folder in favor of undocumented *_path Applies code-review comments * Reuse source files from test_package Applies code-review comments * Apply suggestions from code review Co-authored-by: Jordan Williams <jordan@jwillikers.com> * Use export_conandata_patches Bump up the minimum conan version to 1.52 Applies code-review comments * Removed unused conf_info values As descibed in #13490 Applies code-review comments * Check against empty string for conf value bash path Apply code review comment * Update recipes/autoconf/all/conanfile.py Co-authored-by: Chris Mc <prince.chrismc@gmail.com> * Apply suggestions from code review Co-authored-by: SpaceIm <30052553+SpaceIm@users.noreply.github.com> Co-authored-by: j.spijker@ultimaker.com <jelle spijker> Co-authored-by: Jordan Williams <jordan@jwillikers.com> Co-authored-by: Chris Mc <prince.chrismc@gmail.com> Co-authored-by: SpaceIm <30052553+SpaceIm@users.noreply.github.com>

docs: v2 migration guidence for conf_info

a02cd00

conan-center-bot added the Docs label Oct 14, 2022

github-actions bot mentioned this pull request Oct 14, 2022

Pull Requests Ready to be Reviewed prince-chrismc/conan-center-index-pending-review#1

Open

SSE4 reviewed Oct 15, 2022

View reviewed changes

jwillikers suggested changes Oct 15, 2022

View reviewed changes

Update docs/v2_migration.md

bc36f41

Co-authored-by: Jordan Williams <jordan@jwillikers.com>

conan-center-bot added Docs and removed Docs labels Oct 15, 2022

This was referenced Oct 18, 2022

strawberryperl: conan v2 #13429

Merged

strawberryperl: few improvements #13581

Merged

example + notes about why to avoid it

58f7fdb

prince-chrismc requested a review from jcar87 October 18, 2022 18:47

prince-chrismc mentioned this pull request Oct 19, 2022

[autoconf] conan v2 #12896

Merged

4 tasks

uilianries approved these changes Oct 19, 2022

View reviewed changes

jwillikers approved these changes Oct 19, 2022

View reviewed changes

conan-center-bot merged commit 842c55b into conan-io:master Oct 19, 2022

jellespijker added a commit to Ultimaker/conan-center-index that referenced this pull request Oct 23, 2022

Removed unused conf_info values

642c352

As descibed in conan-io#13490 Applies code-review comments

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: v2 migration guidence for `conf_info` #13490

docs: v2 migration guidence for `conf_info` #13490

prince-chrismc commented Oct 14, 2022

SSE4 Oct 15, 2022

jwillikers Oct 15, 2022

prince-chrismc Oct 15, 2022

SSE4 Oct 15, 2022 •

edited

Loading

uilianries Oct 18, 2022 •

edited

Loading

prince-chrismc Oct 18, 2022

prince-chrismc Oct 19, 2022

jwillikers Oct 15, 2022

prince-chrismc commented Oct 17, 2022

	self.user_info.CONFIG_GUESS = os.path.join(bin_path, "config.guess")
	self.user_info.CONFIG_SUB = os.path.join(bin_path, "config.sub")

	shutil.copy(self._user_info_build["gnu-config"].CONFIG_SUB,
	os.path.join(self._source_subfolder, "config.sub"))
	shutil.copy(self._user_info_build["gnu-config"].CONFIG_GUESS,
	os.path.join(self._source_subfolder, "config.guess"))

docs: v2 migration guidence for conf_info #13490

docs: v2 migration guidence for conf_info #13490

Conversation

prince-chrismc commented Oct 14, 2022

SSE4 Oct 15, 2022

Choose a reason for hiding this comment

jwillikers Oct 15, 2022

Choose a reason for hiding this comment

prince-chrismc Oct 15, 2022

Choose a reason for hiding this comment

SSE4 Oct 15, 2022 • edited Loading

Choose a reason for hiding this comment

uilianries Oct 18, 2022 • edited Loading

Choose a reason for hiding this comment

prince-chrismc Oct 18, 2022

Choose a reason for hiding this comment

prince-chrismc Oct 19, 2022

Choose a reason for hiding this comment

jwillikers Oct 15, 2022

Choose a reason for hiding this comment

prince-chrismc commented Oct 17, 2022

docs: v2 migration guidence for `conf_info` #13490

docs: v2 migration guidence for `conf_info` #13490

SSE4 Oct 15, 2022 •

edited

Loading

uilianries Oct 18, 2022 •

edited

Loading