From 9d434813634bfab6f306f04ef1b3470aa8fedf86 Mon Sep 17 00:00:00 2001 From: Ernesto Miguez Date: Fri, 29 May 2026 13:26:57 +0200 Subject: [PATCH 1/2] docs: fix typo --- docs/src/using-criticalup/running-tools.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/using-criticalup/running-tools.rst b/docs/src/using-criticalup/running-tools.rst index 3f1f8533..69e2865e 100644 --- a/docs/src/using-criticalup/running-tools.rst +++ b/docs/src/using-criticalup/running-tools.rst @@ -58,7 +58,7 @@ toolchain. 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`` +should either 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. From 557d139ca86b8fcb2141a4153fe73b98a14415e7 Mon Sep 17 00:00:00 2001 From: Ernesto Miguez Date: Mon, 1 Jun 2026 13:52:23 +0200 Subject: [PATCH 2/2] doc: installation run on different scenarios Moves and changes some text in the explanation on running the tools, to makes clear that if a rustup installation is present, criticalup should be used as a rustup toolchain Documents --strict flag and its usage to prevent using binaries outside the installation --- docs/src/using-criticalup/running-tools.rst | 35 ++++++++++++++++----- 1 file changed, 27 insertions(+), 8 deletions(-) diff --git a/docs/src/using-criticalup/running-tools.rst b/docs/src/using-criticalup/running-tools.rst index 69e2865e..24c3b0d7 100644 --- a/docs/src/using-criticalup/running-tools.rst +++ b/docs/src/using-criticalup/running-tools.rst @@ -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 `` + .. 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 ^^^^^^^^^^^^^^ @@ -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. -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 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:: @@ -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 ------------------