Skip to content

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

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Mar 1, 2025
Merged

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

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
960900c
Update getting_started.rst
instinct-vfx Feb 25, 2025
dfed5e1
Fix formatting
instinct-vfx Feb 25, 2025
9484cff
Fix option link for --quickstart
instinct-vfx Feb 25, 2025
ae8ab86
Update docs/source/getting_started.rst
JeanChristopheMorinPerso Mar 1, 2025
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
6 changes: 6 additions & 0 deletions docs/source/getting_started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down