[dev2] Profiles and Configuration Files #2947

franramirez688 · 2023-02-02T16:33:03Z

WIP!!

reference/commands/profile.rst

memsharded

Good start, just added a few notes of things to remove, being dropped in 2.0.

reference.rst

reference/configuration_files.rst

reference/configuration_files/artifacts.properties.rst

reference/configuration_files/client_certificates.rst

reference/configuration_files/default_profile.rst

reference/configuration_files/editable_layout.rst

memsharded

Hi @franramirez688

Tons of work here, thank you!
However I see some innaccuracies, mistakes, usage of removed 1.X functionality, etc. It would be better to write from scratch, and little by little than trying to migrate Conan 1.X docs, they are too outdated to be ported.

memsharded · 2023-02-07T14:18:09Z

reference/config_files/client_certificates.rst

+.. _reference_config_files_client_certificates:
+
+
+Client certificates


This is not a first level item. It is just 1 config item from global.conf. It is not at the same level as settings, profiles, etc.

memsharded · 2023-02-07T14:18:46Z

reference/config_files/conandata.yml.rst

@@ -0,0 +1,50 @@
+.. _reference_config_files_conandata_yml:
+
+conandata.yml


Uhm, I'd probably do not put this as config-file. I'd move this section to conanfile.py section.

memsharded · 2023-02-07T14:19:44Z

reference/config_files/default_profile.rst

+
+.. code-block:: bash
+
+    $ conan create . demo/testing -pr=myprofile


This demo/testing is not valid syntax anymore

memsharded · 2023-02-07T14:20:26Z

reference/config_files/default_profile.rst

@@ -0,0 +1,519 @@
+.. _reference_config_files_default_profile:
+
+profiles/default


This section is not about profiles/default, it should be just profiles

memsharded · 2023-02-07T14:21:07Z

reference/config_files/default_profile.rst

+    os=Macos
+
+
+Use ``$PROFILE_DIR`` in your profile and it will be replaced with the absolute path to


PROFILE_DIR deprecated in 2.0, use jinja injected variable!

memsharded · 2023-02-07T14:27:08Z

reference/config_files/global_conf.rst

+Configuration file template
+---------------------------
+
+Available since: `1.46.0 <https://github.com/conan-io/conan/releases/tag/1.46.0>`_


memsharded · 2023-02-07T14:27:23Z

reference/config_files/global_conf.rst

+Configuration data types
+------------------------
+
+Available since: `1.46.0 <https://github.com/conan-io/conan/releases/tag/1.46.0>`_


memsharded · 2023-02-07T14:28:00Z

reference/config_files/global_conf.rst

+
+.. _conf_in_recipes:
+
+Configuration in your recipes


Better link to somewhere else under conanfile section

memsharded · 2023-02-07T14:29:29Z

reference/config_files/settings.yml.rst

+As you can see, the possible values ``settings`` can take are restricted in the same file. This is done to ensure matching naming and
+spelling as well as defining a common settings model among users and the OSS community.
+If a setting is allowed to be set to any value, you can use ``ANY``.
+If a setting is allowed to be set to any value or it can also be unset, you can use ``[None, ANY]``.


Modern syntax is yaml, using null, not None

memsharded · 2023-02-07T14:29:45Z

reference/config_files/settings.yml.rst

+- It is only used by the new build integrations in :ref:`conan_tools_cmake` and :ref:`conan_tools_microsoft`, but not the previous ones.
+- At the moment it implements a ``compatible_packages`` fallback to Visual Studio compiled packages, that is, previous existing binaries
+  compiled with ``settings.compiler="Visual Studio"`` can be used for the ``msvc`` compiler if no binaries exist for it yet.
+  This behavior can be opted-out with ``core.package_id:msvc_visual_incompatible`` :ref:`reference_config_files_global_conf` configuration.


LEgacy, remove

SSE4 · 2023-02-08T03:49:44Z

reference/config_files/client_certificates.rst

+Conan supports client TLS certificates. You can configure the path to your existing *Cacert* file and/or your client
+certificate (and the key) using the following configuration variables:
+
+* ``core.net.http:cacert_path``: Path containing a custom Cacert file.


is it expected to be in PEM format, or something else? it's not clear

reference/config_files/default_profile.rst

SSE4 · 2023-02-08T03:51:59Z

reference/config_files/default_profile.rst

+
+Conan profiles allows users to set a complete configuration set for **settings**, **options**,
+**environment variables** (for build time and runtime context), **requirements** (and build requirements), and
+**configuration variables** in a file.


I think it's INI file?

SSE4 · 2023-02-08T03:55:40Z

reference/config_files/default_profile.rst

+
+Another essential point to mention is the possibility of defining variables as `PATH` ones by simply putting ``(path)`` as
+the prefix of the variable. It is useful to automatically get the append/prepend of the `PATH` in different systems
+(Windows uses ``;`` as separation, and UNIX ``:``).


how does it work in case of cross-compiling? it's not crystal clear if it just uses os.name or self.settings.os.

SSE4 · 2023-02-08T03:58:31Z

reference/config_files/default_profile.rst

+Profile includes
+----------------
+
+You can include other profiles using the ``include()`` statement. The path can be relative to the current profile, absolute, or a profile


in this case, it's kinda unclear how do nested include() statements work with relative paths, e.g. we have:

cat a.profile include(../b.profile) cat b.profile include(../c.profile)

will it resolve to ../../c.profile or just ../c.profile?

Co-authored-by: SSE4 <tomskside@gmail.com>

franramirez688 · 2023-02-08T09:08:55Z

I'm going to close this one and open several ones to reduce the diff.

franramirez688 added this to the 2.0.0-beta10 milestone Feb 2, 2023

franramirez688 mentioned this pull request Feb 2, 2023

[Reference] Missing sections #2943

Open

40 tasks

franramirez688 commented Feb 2, 2023

View reviewed changes

reference/commands/profile.rst Outdated Show resolved Hide resolved

memsharded reviewed Feb 2, 2023

View reviewed changes

franramirez688 force-pushed the config_files_v2 branch from b680fde to 19a0f4b Compare February 6, 2023 17:37

franramirez688 changed the base branch from develop2 to release/2.0.0-beta February 6, 2023 17:38

franramirez688 added 3 commits February 6, 2023 18:39

Added configuration files

dca9124

wip

06ee5e4

wip

dc86bac

franramirez688 force-pushed the config_files_v2 branch from 19a0f4b to dc86bac Compare February 6, 2023 17:39

wip

777b0b4

memsharded requested changes Feb 7, 2023

View reviewed changes

SSE4 reviewed Feb 8, 2023

View reviewed changes

reference/config_files/default_profile.rst Outdated Show resolved Hide resolved

SSE4 reviewed Feb 8, 2023

View reviewed changes

reference/config_files/default_profile.rst Outdated Show resolved Hide resolved

SSE4 reviewed Feb 8, 2023

View reviewed changes

franramirez688 and others added 2 commits February 8, 2023 09:48

Update reference/config_files/default_profile.rst

1bd99b1

Co-authored-by: SSE4 <tomskside@gmail.com>

Update reference/config_files/default_profile.rst

d6d267c

Co-authored-by: SSE4 <tomskside@gmail.com>

franramirez688 closed this Feb 8, 2023

franramirez688 mentioned this pull request Feb 8, 2023

[dev2] Configuration files: global.conf #2955

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[dev2] Profiles and Configuration Files #2947

[dev2] Profiles and Configuration Files #2947

franramirez688 commented Feb 2, 2023

memsharded left a comment

memsharded left a comment

memsharded Feb 7, 2023

memsharded Feb 7, 2023

memsharded Feb 7, 2023

memsharded Feb 7, 2023

memsharded Feb 7, 2023

memsharded Feb 7, 2023

memsharded Feb 7, 2023

memsharded Feb 7, 2023

memsharded Feb 7, 2023

memsharded Feb 7, 2023

SSE4 Feb 8, 2023

SSE4 Feb 8, 2023

SSE4 Feb 8, 2023

SSE4 Feb 8, 2023

franramirez688 commented Feb 8, 2023

		.. _reference_config_files_client_certificates:


		Client certificates

		@@ -0,0 +1,50 @@
		.. _reference_config_files_conandata_yml:

		conandata.yml


		.. code-block:: bash

		$ conan create . demo/testing -pr=myprofile

		@@ -0,0 +1,519 @@
		.. _reference_config_files_default_profile:

		profiles/default

		os=Macos


		Use ``$PROFILE_DIR`` in your profile and it will be replaced with the absolute path to

[dev2] Profiles and Configuration Files #2947

[dev2] Profiles and Configuration Files #2947

Conversation

franramirez688 commented Feb 2, 2023

memsharded left a comment

Choose a reason for hiding this comment

memsharded left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

franramirez688 commented Feb 8, 2023