Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update the status of more feature to "under development" #2878

Merged
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion extending/hooks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,11 @@
Hooks
=====


.. warning::

This is an **experimental** feature subject to breaking changes in future releases.
This is a **migrated** feature. Please refer to the :ref:`Migration Guidelines<conan2_migration_guide>` learn about the changes.
prince-chrismc marked this conversation as resolved.
Show resolved Hide resolved
Most of the functionality remains intact and the main changes are adapting to the new features that are introduced.

The Conan hooks is a feature intended to extend the Conan functionalities and let users customize the client behavior at determined
points.
Expand Down
43 changes: 23 additions & 20 deletions reference/conanfile/attributes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1122,12 +1122,13 @@ has **the same default directories**.
Dependencies among components and to components of other requirements can be defined using the ``requires`` attribute and the name
of the component. The dependency graph for components will be calculated and values will be aggregated in the correct order for each field.

**New properties model for the cpp_info new tools**
New properties model for the cpp_info new tools
+++++++++++++++++++++++++++++++++++++++++++++++

.. warning::
.. important::

Using ``set_property`` and ``get_property`` methods for ``cpp_info`` is an **experimental**
feature subject to breaking changes in future releases.
This feature is still **under development**, while it is recommended and usable and we will try not to break them in future releases,
some breaking changes might still happen if necessary to prepare for the *Conan 2.0 release*.

Using ``.names``, ``.filenames`` and ``.build_modules`` will not work any more for new
generators, like :ref:`CMakeDeps<CMakeDeps>` and :ref:`PkgConfigDeps<PkgConfigDeps>`.
Expand Down Expand Up @@ -1438,9 +1439,8 @@ scm

.. warning::

This is an **experimental** feature subject to breaking changes in future releases. Although this
is an experimental feature, the use of the feature using ``scm_to_conandata`` is considered
stable.
This is a **deprecated** feature. Please refer to the :ref:`Migration Guidelines<conan2_migration_guide>`
to find the feature that replaced this one.

Used to clone/checkout a repository. It is a dictionary with the following possible values:

Expand Down Expand Up @@ -1528,9 +1528,7 @@ python_requires (legacy)

.. warning::

This attribute has been superseded by the new :ref:`python_requires`. Even if this is an **experimental**
feature subject to breaking changes in future releases, this legacy ``python_requires`` syntax has not
been removed yet, but it will be removed in Conan 2.0.
This is a **deprecated** feature by the new :ref:`python_requires`.

Python requires are associated with the ``ConanFile`` declared in the recipe file, data
from those imported recipes is accessible using the ``python_requires`` attribute in
Expand Down Expand Up @@ -1561,9 +1559,10 @@ workspace.:
python_requires
---------------

.. warning::
.. important::

This is an **experimental** feature subject to breaking changes in future releases.
This feature is still **under development**, while it is recommended and usable and we will try not to break them in future releases,
some breaking changes might still happen if necessary to prepare for the *Conan 2.0 release*.

This class attribute allows to define a dependency to another Conan recipe and reuse its code.
Its basic syntax is:
Expand All @@ -1588,9 +1587,10 @@ Read more about this attribute in :ref:`python_requires`
python_requires_extend
----------------------

.. warning::
.. important::

This is an **experimental** feature subject to breaking changes in future releases.
This feature is still **under development**, while it is recommended and usable and we will try not to break them in future releases,
some breaking changes might still happen if necessary to prepare for the *Conan 2.0 release*.


This class attribute defines one or more classes that will be injected in runtime as base classes of
Expand Down Expand Up @@ -1741,9 +1741,10 @@ If the attribute is omitted, the value of the attribute is assumed to be equal t
conf
----

.. warning::
.. important::

This is an **experimental** feature subject to breaking changes in future releases.
This feature is still **under development**, while it is recommended and usable and we will try not to break them in future releases,
some breaking changes might still happen if necessary to prepare for the *Conan 2.0 release*.

Available since: `1.47.0 <https://github.com/conan-io/conan/releases/tag/1.47.0>`_

Expand Down Expand Up @@ -1816,9 +1817,10 @@ Without the profile:
win_bash
--------

.. warning::
.. important::

This is an **experimental** feature subject to breaking changes in future releases.
This feature is still **under development**, while it is recommended and usable and we will try not to break them in future releases,
some breaking changes might still happen if necessary to prepare for the *Conan 2.0 release*.

Available since: `1.39.0 <https://github.com/conan-io/conan/releases/tag/1.39.0>`_

Expand Down Expand Up @@ -1863,9 +1865,10 @@ When ``True`` it enables running commands in the ``"run"`` scope, to run them in
test_type
---------

.. warning::
.. important::

Test type is an **experimental** feature subject to breaking changes in future releases.
This feature is still **under development**, while it is recommended and usable and we will try not to break them in future releases,
some breaking changes might still happen if necessary to prepare for the *Conan 2.0 release*.

Available since: `1.44.0 <https://github.com/conan-io/conan/releases/tag/1.44.0>`_

Expand Down
5 changes: 3 additions & 2 deletions reference/conanfile/dependencies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@
Dependencies
============

.. warning::
.. important::

These tools are **experimental** and subject to breaking changes.
This feature is still **under development**, while it is recommended and usable and we will try not to break them in future releases,
some breaking changes might still happen if necessary to prepare for the *Conan 2.0 release*.

Available since: `1.38.0 <https://github.com/conan-io/conan/releases/tag/1.38.0>`_

Expand Down
22 changes: 11 additions & 11 deletions reference/conanfile/methods.rst
Original file line number Diff line number Diff line change
Expand Up @@ -536,18 +536,14 @@ This exception will be propagated and Conan application will finish with a :ref:

.. note::

For managing invalid configurations, please check the new experimental ``validate()`` method (:ref:`method_validate`).
For managing invalid configurations, please check the new ``validate()`` method (:ref:`method_validate`).


.. _method_validate:

validate()
----------

.. warning::

This is an **experimental** feature subject to breaking changes in future releases.

Available since: `1.32.0 <https://github.com/conan-io/conan/releases/tag/1.32.0>`_

The ``validate()`` method can be used to mark a binary as "impossible" or invalid for a given configuration. For example,
Expand Down Expand Up @@ -1254,9 +1250,10 @@ be done.
compatibility()
---------------

.. warning::
.. important::

This is an **experimental** feature subject to breaking changes in future releases.
This feature is still **under development**, while it is recommended and usable and we will try not to break them in future releases,
some breaking changes might still happen if necessary to prepare for the *Conan 2.0 release*.

Available since Conan `1.47.0 <https://github.com/conan-io/conan/releases/tag/1.47.0>`_

Expand Down Expand Up @@ -1497,9 +1494,10 @@ current folder (the one containing the *conanfile.py*). The ``dst`` is relative
generate()
----------

.. warning::
.. important::
prince-chrismc marked this conversation as resolved.
Show resolved Hide resolved

This is an **experimental** feature subject to breaking changes in future releases.
This feature is still **under development**, while it is recommended and usable and we will try not to break them in future releases,
some breaking changes might still happen if necessary to prepare for the *Conan 2.0 release*.

Available since: `1.32.0 <https://github.com/conan-io/conan/releases/tag/1.32.0>`_

Expand Down Expand Up @@ -1559,9 +1557,11 @@ multiple recipes.
layout()
--------

.. warning::
.. important::

This feature is still **under development**, while it is recommended and usable and we will try not to break them in future releases,
some breaking changes might still happen if necessary to prepare for the *Conan 2.0 release*.

This is an **experimental** feature subject to breaking changes in future releases.
The ``layout()`` feature will be fully functional only in the new build system integrations
(:ref:`in the conan.tools space <conan_tools>`). If you are using other integrations, they
might not fully support this feature.
Expand Down
6 changes: 3 additions & 3 deletions reference/conanfile/tools/cmake.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
conan.tools.cmake
=================

.. warning::
.. important::

These tools are still **experimental** (so subject to breaking changes) but with very stable syntax.
We encourage their usage to be prepared for Conan 2.0.
This feature is still **under development**, while it is recommended and usable and we will try not to break them in future releases,
some breaking changes might still happen if necessary to prepare for the *Conan 2.0 release*.

You can use ``conan new hello/0.1 --template=cmake_lib`` and ``conan new hello/0.1 --template=cmake_exe`` templates
to try this CMake integration.
Expand Down
6 changes: 3 additions & 3 deletions reference/conanfile/tools/gnu.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
conan.tools.gnu
===============

.. warning::
.. important::

These tools are still **experimental** (so subject to breaking changes) but with very stable syntax.
We encourage their usage to be prepared for Conan 2.0.
This feature is still **under development**, while it is recommended and usable and we will try not to break them in future releases,
some breaking changes might still happen if necessary to prepare for the *Conan 2.0 release*.

.. toctree::
:maxdepth: 2
Expand Down
6 changes: 3 additions & 3 deletions reference/conanfile/tools/gnu/pkgconfig.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
PkgConfig
=========

.. warning::
.. important::

These tools are still **experimental** (so subject to breaking changes) but with very stable syntax.
We encourage their usage to be prepared for Conan 2.0.
This feature is still **under development**, while it is recommended and usable and we will try not to break them in future releases,
some breaking changes might still happen if necessary to prepare for the *Conan 2.0 release*.

Available since: `1.45.0 <https://github.com/conan-io/conan/releases/tag/1.45.0>`_

Expand Down
6 changes: 3 additions & 3 deletions reference/conanfile/tools/gnu/pkgconfigdeps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
PkgConfigDeps
=============

.. warning::
.. important::

These tools are still **experimental** (so subject to breaking changes) but with very stable syntax.
We encourage their usage to be prepared for Conan 2.0.
This feature is still **under development**, while it is recommended and usable and we will try not to break them in future releases,
some breaking changes might still happen if necessary to prepare for the *Conan 2.0 release*.


.. _PkgConfigDeps:
Expand Down
5 changes: 3 additions & 2 deletions reference/conanfile/tools/google.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@
conan.tools.google
==================

.. warning::
.. important::

These tools are **experimental** and subject to breaking changes.
This feature is still **under development**, while it is recommended and usable and we will try not to break them in future releases,
some breaking changes might still happen if necessary to prepare for the *Conan 2.0 release*.


BazelDeps
Expand Down
5 changes: 3 additions & 2 deletions reference/conanfile/tools/meson.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@
conan.tools.meson
=================

.. warning::
.. important::

These tools are **experimental** and subject to breaking changes.
This feature is still **under development**, while it is recommended and usable and we will try not to break them in future releases,
some breaking changes might still happen if necessary to prepare for the *Conan 2.0 release*.


You can use ``conan new hello/0.1 --template=meson_lib`` and ``conan new hello/0.1 --template=meson_exe`` templates
Expand Down
11 changes: 4 additions & 7 deletions reference/conanfile/tools/meson/meson.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,14 @@
Meson
-----

.. warning::
.. important::

This is an **experimental** feature subject to breaking changes in future releases.
This feature is still **under development**, while it is recommended and usable and we will try not to break them in future releases,
some breaking changes might still happen if necessary to prepare for the *Conan 2.0 release*.

Available since: `1.33.0 <https://github.com/conan-io/conan/releases/tag/1.33.0>`_

The ``Meson()`` build helper that works with the ``MesonToolchain`` is also experimental,
and subject to breaking change in the future. It will evolve to adapt and complement the
toolchain functionality.

The helper is intended to be used in the ``build()`` method, to call Meson commands automatically
This helper is intended to be used in the ``build()`` method, to call Meson commands automatically
when a package is being built directly by Conan (create, install)

.. code:: python
Expand Down
6 changes: 3 additions & 3 deletions reference/conanfile/tools/meson/mesondeps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
MesonDeps
=========

.. warning::
.. important::

These tools are still **experimental** (so subject to breaking changes) but with very stable syntax.
We encourage their usage to be prepared for Conan 2.0.
This feature is still **under development**, while it is recommended and usable and we will try not to break them in future releases,
some breaking changes might still happen if necessary to prepare for the *Conan 2.0 release*.

Available since: `1.51.0 <https://github.com/conan-io/conan/releases/tag/1.51.0>`_

Expand Down
5 changes: 3 additions & 2 deletions reference/conanfile/tools/meson/mesontoolchain.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@
MesonToolchain
--------------

.. warning::
.. important::

This is an **experimental** feature subject to breaking changes in future releases.
This feature is still **under development**, while it is recommended and usable and we will try not to break them in future releases,
some breaking changes might still happen if necessary to prepare for the *Conan 2.0 release*.


.. important::
Expand Down
2 changes: 1 addition & 1 deletion reference/conanfile/tools/microsoft.rst
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ switching dependencies from static to shared libraries.
Included dependencies
+++++++++++++++++++++

``MSBuildDeps`` uses the new experimental ``self.dependencies`` access to dependencies. The following
``MSBuildDeps`` uses the new ``self.dependencies`` access to dependencies. The following
dependencies will be translated to properties files:

- All direct dependencies, that is, the ones declared by the current ``conanfile``, that lives in the
Expand Down
5 changes: 3 additions & 2 deletions reference/conanfile/tools/qbs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@ conan.tools.qbs
QbsProfile
------------

.. warning::
.. important::

This is an **experimental** feature subject to breaking changes in future releases.
This feature is still **under development**, while it is recommended and usable and we will try not to break them in future releases,
some breaking changes might still happen if necessary to prepare for the *Conan 2.0 release*.

Available since: `1.33.0 <https://github.com/conan-io/conan/releases/tag/1.33.0>`_

Expand Down
7 changes: 5 additions & 2 deletions reference/conanfile/tools/scm/git.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,12 @@
Git
===

.. warning::
.. important::

This tool is **experimental** and subject to breaking changes. This tool is intended to replace the current ``conans.tools.Git`` and the current ``scm`` attribute, that will be removed in Conan 2.0.
This feature is still **under development**, while it is recommended and usable and we will try not to break them in future releases,
some breaking changes might still happen if necessary to prepare for the *Conan 2.0 release*.

This tool is intended to replace the current ``conans.tools.Git`` and the current ``scm`` attribute, that will be removed in Conan 2.0.

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

Expand Down
5 changes: 3 additions & 2 deletions reference/conanfile/tools/scm/other.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. _conan_tools_scm_version:

.. warning::
.. important::

This tools are **experimental** and subject to breaking changes.
This feature is still **under development**, while it is recommended and usable and we will try not to break them in future releases,
some breaking changes might still happen if necessary to prepare for the *Conan 2.0 release*.

conan_version
=============
Expand Down
5 changes: 3 additions & 2 deletions reference/conanfile/tools/system.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
conan.tools.system
==================

.. warning::
.. important::

These tools are **experimental** and subject to breaking changes.
This feature is still **under development**, while it is recommended and usable and we will try not to break them in future releases,
some breaking changes might still happen if necessary to prepare for the *Conan 2.0 release*.


.. toctree::
Expand Down
5 changes: 3 additions & 2 deletions reference/conanfile/tools/system/package_manager.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@
conan.tools.system.package_manager
==================================

.. warning::
.. important::

These tools are **experimental** and subject to breaking changes.
This feature is still **under development**, while it is recommended and usable and we will try not to break them in future releases,
some breaking changes might still happen if necessary to prepare for the *Conan 2.0 release*.


The tools under `conan.tools.system.package_manager` are wrappers around some of the most
Expand Down
Loading