Skip to content

Commit 2933636

Browse files
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]>
1 parent 1d50721 commit 2933636

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/source/getting_started.rst

+6
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ Getting started
55
Essential packages
66
==================
77

8+
.. warning::
9+
:ref:`rez-bind` is going to be deprecated. The current implementation is not actively maintained.
10+
Especially on windows, using :option:`--quickstart <rez-bind --quickstart>` is likely to fail.
11+
12+
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.
13+
814
After installation, you need to create some essential Rez packages. The :ref:`rez-bind`
915
tool creates Rez packages that reference software already installed on your system.
1016
Use the :option:`--quickstart <rez-bind --quickstart>` argument to bind a set of standard packages:

0 commit comments

Comments
 (0)