From 960900c162e963961ff7cc762a26241ca48bbd93 Mon Sep 17 00:00:00 2001 From: Thorsten Kaufmann Date: Tue, 25 Feb 2025 08:58:50 +0100 Subject: [PATCH 1/4] Update getting_started.rst Signed-off-by: Thorsten Kaufmann --- docs/source/getting_started.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index 2872fe4fc..bd7461bf7 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -5,6 +5,10 @@ Getting started Essential packages ================== +.. warning:: + `rez-bind` is going to be deprecated. The current implementation is not actively maintained. + Especially on windows, using `--quickstart` is likely to fail. + 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 ` argument to bind a set of standard packages: From dfed5e1056b6768b7e551fe78cc168059ea8c1a6 Mon Sep 17 00:00:00 2001 From: Thorsten Kaufmann Date: Tue, 25 Feb 2025 10:05:43 +0100 Subject: [PATCH 2/4] Fix formatting Signed-off-by: Thorsten Kaufmann --- docs/source/getting_started.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index bd7461bf7..d13ad64be 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -6,8 +6,8 @@ Essential packages ================== .. warning:: - `rez-bind` is going to be deprecated. The current implementation is not actively maintained. - Especially on windows, using `--quickstart` is likely to fail. + :ref:`rez-bind` is going to be deprecated. The current implementation is not actively maintained. + Especially on windows, using :option:`--quickstart` is likely to fail. 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. From 9484cff68870506003d5c01e2b89c29cd1172bb3 Mon Sep 17 00:00:00 2001 From: Thorsten Kaufmann Date: Tue, 25 Feb 2025 10:07:09 +0100 Subject: [PATCH 3/4] Fix option link for --quickstart Signed-off-by: Thorsten Kaufmann --- docs/source/getting_started.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index d13ad64be..b96f092aa 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -7,7 +7,7 @@ Essential packages .. warning:: :ref:`rez-bind` is going to be deprecated. The current implementation is not actively maintained. - Especially on windows, using :option:`--quickstart` is likely to fail. + Especially on windows, using :option:`--quickstart ` is likely to fail. 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. From ae8ab8636f9d100697a75efb86f7b62fc221c493 Mon Sep 17 00:00:00 2001 From: Jean-Christophe Morin <38703886+JeanChristopheMorinPerso@users.noreply.github.com> Date: Sat, 1 Mar 2025 17:35:10 -0500 Subject: [PATCH 4/4] Update docs/source/getting_started.rst Signed-off-by: Jean-Christophe Morin <38703886+JeanChristopheMorinPerso@users.noreply.github.com> --- docs/source/getting_started.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index b96f092aa..3b5696649 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -9,6 +9,8 @@ Essential packages :ref:`rez-bind` is going to be deprecated. The current implementation is not actively maintained. Especially on windows, using :option:`--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 ` argument to bind a set of standard packages: