Chore/add warning about rez bind to docs fixes #1729 (#1922)

Signed-off-by: Thorsten Kaufmann <[email protected]> Signed-off-by: Jean-Christophe Morin <[email protected]> Co-authored-by: Jean-Christophe Morin <[email protected]>
AcademySoftwareFoundation · Mar 1, 2025 · 2933636 · 2933636
1 parent 1d50721
commit 2933636
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst
@@ -5,6 +5,12 @@ Getting started
 Essential packages
 ==================
 
+.. warning::
+   :ref:`rez-bind` is going to be deprecated. The current implementation is not actively maintained.
+   Especially on windows, using :option:`--quickstart <rez-bind --quickstart>` is likely to fail.
+
+   Even if rez-bind will be deprecated and we generally discourage its use, you can safely use it for creating the ``arch``, ``os`` and ``platform`` packages.
+
 After installation, you need to create some essential Rez packages. The :ref:`rez-bind`
 tool creates Rez packages that reference software already installed on your system.
 Use the :option:`--quickstart <rez-bind --quickstart>` argument to bind a set of standard packages: