Skip to content
Open
Changes from all commits
Commits
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
35 changes: 27 additions & 8 deletions docs/src/using-criticalup/running-tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,26 @@ CriticalUp will scan the working directory, then any parents, to discover the re
it will search the parent directory, then the parent of that, up to the root
directory of the system.


Any binary package installed via CriticalUp you can be run with the command ``criticalup run <binary>``

.. code-block::

cd project
criticalup run rustc --help

.. important::

Ferrocene binaries share the same binary names as any Rust toolchain that may already be installed.

If necessary, to make sure you **only execute the specified binary if it is part of the installation**, run the command with the ``--strict`` flag.

.. code-block::

cd project
criticalup run --strict rustc --help



Locating Tools
^^^^^^^^^^^^^^
Expand All @@ -53,20 +68,21 @@ Using the Binary Proxies
^^^^^^^^^^^^^^^^^^^^^^^^

CriticalUp creates a number of binary proxies which can be used to run the appropriate Ferrocene
binaries for a given workspace. These can be added to your shell path on any OS, or used as a ``rustup``
toolchain.
binaries for a given workspace. These can be added to your shell path on any OS. See :ref:`on-your-shell-path` for more details.
They can also be used as a rustup toolchain, as described in the next section :ref:`as-a-rustup-toolchain`.

.. important::

To prevent executing an unintended binary, If you already have Rust installed via ``rustup`` you **should** add the CriticalUp installation as a ``rustup`` toolchain.
Comment thread
emig marked this conversation as resolved.

It's important to note that these binaries share the same binary names as any Rust toolchain that
may already be installed. If you already have Rust installed (for example, via ``rustup``) you
should either to remove it, use Ferrocene via ``criticalup run``, or add Ferrocene as a ``rustup``
toolchain.

Optionally, Ferrocene can be used as a ``rustup`` toolchain that may feel familiar to some developers.
.. _as-a-rustup-toolchain:

As a ``rustup`` toolchain
-------------------------

If you already have ``rustup`` installed, you can add a ``ferrocene`` toolchain:
Ferrocene can be used as a ``rustup`` toolchain that may feel familiar to some developers.


.. code-block::

Expand Down Expand Up @@ -115,6 +131,9 @@ Then, by default, the Ferrocene toolchain created above should be used. Other
``rustup`` toolchains can still be used, for example, ``cargo +stable run``.



.. _on-your-shell-path:

On your shell path
------------------

Expand Down