Skip to content

Commit

Permalink
Adjust docs a bit
Browse files Browse the repository at this point in the history
Signed-off-by: Jean-Christophe Morin <[email protected]>
  • Loading branch information
JeanChristopheMorinPerso committed Feb 8, 2024
1 parent 3b199da commit 81b608d
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 21 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Change of default values as announced in 2.114.0:

New unannounced changes:

- The default shell on Windows will now be PowerShell unless you configure `default_shell`
- The default shell on Windows is now PowerShell unless you configure `default_shell`
to a different value. The previous default was `cmd` and was causing a lot of problems.

### Docs
Expand Down
2 changes: 1 addition & 1 deletion docs/source/guides/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ This section contains various user guides.
.. toctree::
:maxdepth: 1

prepare_for_3
update_to_3
Original file line number Diff line number Diff line change
@@ -1,35 +1,37 @@
=====================
Prepare for rez 3.0.0
=====================
===================
Update to rez 3.0.0
===================

The rez TSC started to prepare to release rez ``3.0.0``. Rez ``3.0.0`` will not be
a major breaking change but will still remove some things.
Rez ``3.0.0`` is not be a major breaking change, except that Python 2 is not supported anymore.
There is various other small changes too.

This guide will show you how to prepare in advance before ``3.0.0`` is released so
that you are not caught by surprise by the changes made in ``3.0.0`` once you start
using ``3.0.0``. We hope that this guide will help make the upgrade process smoother.
This guide will show you how to prepare before upgrading to ``3.0.0``. We hope that this guide will
help make the upgrade process smoother.

Steps for smooth upgrade
========================

#. Read the `release notes <../CHANGELOG.html>`_ for ``2.114.0`` and ``3.0.0`` (once released). The release
notes will contain a list of everything that was deprecated in ``2.114.0`` and will
be removed or changed in ``3.0.0``.
#. Read the `release notes <../CHANGELOG.html>`_ for ``2.114.0`` and ``3.0.0``. The release
notes will contain a list of everything that was deprecated in ``2.114.0`` and removed or
changed in ``3.0.0``.

#. Upgrade to ``2.114.0``.

To upgrade to (or before upgrading to) rez ``3.0.0``, we suggest that you first
upgrade to ``2.114.0``. This is not mandatory and you can jump straight to ``3.0.0``
upgrade to ``2.114.1``. This is not mandatory and you can jump straight to ``3.0.0``
if you wish.


You should prefer 2.114.1 over 2.114.0 because 2.114.0 contained a bug that prevented
rez from correctly running when :envvar:`REZ_LOG_DEPRECATION_WARNINGS` is set.

.. warning::

If you skip this step, you won't be able to see deprecation warnings before
things are removed frm the rez code base.
things are removed/changed from the rez code base.

#. Set the ``REZ_LOG_DEPRECATION_WARNINGS`` environment variable.
#. Set the :envvar:`REZ_LOG_DEPRECATION_WARNINGS` environment variable.

``2.114.1`` adds a new environment variable called :envvar:`REZ_LOG_DEPRECATION_WARNINGS`
``2.114.0`` adds a new environment variable called :envvar:`REZ_LOG_DEPRECATION_WARNINGS`
that will force all rez related deprecation warnings to be printed out to stderr.
This will let you catch if you are using something deprecated that will be removed
in future versions.
Expand All @@ -39,8 +41,7 @@ Steps for smooth upgrade

#. Address each warning one by one.

#. Once you think you have addressed all warnings, upgrade to 3.0.0 (or wait for ``3.0.0`` to
be released if it's not yet available).
#. Once you think you have addressed all warnings, upgrade to 3.0.0.

Optional
========
Expand Down

0 comments on commit 81b608d

Please sign in to comment.