From 17d904604f1567004708164353169b417b17a52f Mon Sep 17 00:00:00 2001 From: George Antonopoulos Date: Fri, 23 May 2025 16:00:25 +0300 Subject: [PATCH 1/4] all rez-bind --quickstart references marked for removal Signed-off-by: George Antonopoulos --- docs/source/getting_started.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index 3b5696649..d0b3c217a 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -7,17 +7,20 @@ Essential packages .. warning:: :ref:`rez-bind` is going to be deprecated. The current implementation is not actively maintained. + .. TODO - Remove reference to rez-bind --quickstart 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. +.. TODO - Remove reference to rez-bind --quickstart Use the :option:`--quickstart ` argument to bind a set of standard packages: .. note:: You may require administrative privileges for some of them +.. TODO - Remove reference to rez-bind --quickstart .. code-block:: text ]$ rez-bind --quickstart From 88829263636d23932e05a069a90ed6f732078cc8 Mon Sep 17 00:00:00 2001 From: George Antonopoulos Date: Fri, 23 May 2025 16:20:36 +0300 Subject: [PATCH 2/4] removed reference to --quistart, replaced with rez bind for all commands mentioned previously but split into safe and optional based on previous note. Signed-off-by: George Antonopoulos --- docs/source/getting_started.rst | 54 ++++++++++++++++++++++++--------- 1 file changed, 40 insertions(+), 14 deletions(-) diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index d0b3c217a..1ccb0ec04 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -7,44 +7,70 @@ Essential packages .. warning:: :ref:`rez-bind` is going to be deprecated. The current implementation is not actively maintained. - .. TODO - Remove reference to rez-bind --quickstart - 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. + However, you can safely use it for creating the essential ``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. -.. TODO - Remove reference to rez-bind --quickstart -Use the :option:`--quickstart ` argument to bind a set of standard packages: + +Create the essential system packages by running these individual commands: .. note:: You may require administrative privileges for some of them -.. TODO - Remove reference to rez-bind --quickstart .. code-block:: text - ]$ rez-bind --quickstart - Binding platform into /home/ajohns/packages... + ]$ rez-bind arch Binding arch into /home/ajohns/packages... + + ]$ rez-bind os Binding os into /home/ajohns/packages... + + ]$ rez-bind platform + Binding platform into /home/ajohns/packages... + + Successfully converted the following essential software found on the current system into Rez packages: + + PACKAGE URI + ------- --- + arch /home/ajohns/packages/arch/x86_64/package.py + os /home/ajohns/packages/os/osx-10.11.5/package.py + platform /home/ajohns/packages/platform/osx/package.py + +Optional packages +----------------- + +You may also want to bind additional packages for your development environment. These can be bound individually as needed: + +.. note:: + These optional packages may be less reliable, especially on Windows. Consider creating + custom package definitions instead if you encounter issues. + +.. code-block:: text + + ]$ rez-bind python # Python interpreter Binding python into /home/ajohns/packages... + + ]$ rez-bind rez # Rez itself Binding rez into /home/ajohns/packages... + + ]$ rez-bind rezgui # Rez GUI tools Binding rezgui into /home/ajohns/packages... + + ]$ rez-bind setuptools # Python setuptools Binding setuptools into /home/ajohns/packages... + + ]$ rez-bind pip # Python package installer Binding pip into /home/ajohns/packages... - Successfully converted the following software found on the current system into Rez packages: + Successfully converted the following essential software found on the current system into Rez packages: PACKAGE URI ------- --- - arch /home/ajohns/packages/arch/x86_64/package.py - os /home/ajohns/packages/os/osx-10.11.5/package.py - pip /home/ajohns/packages/pip/8.0.2/package.py - platform /home/ajohns/packages/platform/osx/package.py python /home/ajohns/packages/python/2.7.11/package.py rez /home/ajohns/packages/rez/2.0.rc1.44/package.py rezgui /home/ajohns/packages/rezgui/2.0.rc1.44/package.py setuptools /home/ajohns/packages/setuptools/19.4/package.py + pip /home/ajohns/packages/pip/8.0.2/package.py Now you should be able to create an environment containing Python. Try this: From 43bccf2a682b2bb47976351211077ed6522eef34 Mon Sep 17 00:00:00 2001 From: George Antonopoulos Date: Tue, 27 May 2025 10:33:07 +0100 Subject: [PATCH 3/4] introducing back missing ref comment Signed-off-by: George Antonopoulos --- docs/source/getting_started.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index 1ccb0ec04..f898abe1f 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -7,7 +7,8 @@ Essential packages .. warning:: :ref:`rez-bind` is going to be deprecated. The current implementation is not actively maintained. - However, you can safely use it for creating the essential ``arch``, ``os`` and ``platform`` packages. + 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. @@ -62,7 +63,7 @@ You may also want to bind additional packages for your development environment. ]$ rez-bind pip # Python package installer Binding pip into /home/ajohns/packages... - Successfully converted the following essential software found on the current system into Rez packages: + Successfully converted the following software found on the current system into Rez packages: PACKAGE URI ------- --- From f9796689b1fd4ba4b316889d801d50af6b3ca666 Mon Sep 17 00:00:00 2001 From: George Antonopoulos Date: Tue, 27 May 2025 10:59:44 +0100 Subject: [PATCH 4/4] docs: remove --quickstart from getting_started.rst * drop all rez-bind --quickstart examples * add individual rez-bind commands * warn about Windows reliability issues Fixes #1961 Signed-off-by: George Antonopoulos --- docs/source/getting_started.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index f898abe1f..5d8890154 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -7,8 +7,7 @@ Essential packages .. warning:: :ref:`rez-bind` is going to be deprecated. The current implementation is not actively maintained. - 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. + 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.