Skip to content

Commit

Permalink
Change formatting of rosdep.
Browse files Browse the repository at this point in the history
Use monospace formatting when referring to the `rosdep` command /
executable name and simply 'rosdep' when referring to the project.

The preferred capitalization of rosdep is rosdep not Rosdep or ROSdep
(and certainly not ROSDep).
  • Loading branch information
nuclearsandwich committed Aug 9, 2024
1 parent f685769 commit 65c7152
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions doc/pip_and_pep_668.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Pip installation after PEP 668

`PEP-668`_ introduced `externally managed environments <externally-managed-environments>`_ to Python packaging.

``rosdep`` is designed to use pip as an alternative system package manager, rosdep installation of pip packages requires installing packages globally as root.
rosdep is designed to use pip as an alternative system package manager, rosdep installation of pip packages requires installing packages globally as root.
Starting with Python 3.11, `PEP-668`_ compliance requires you to allow pip to install alongside externally managed packages using the ``break-system-packages`` option.

There are multiple ways to configure pip so that rosdep will succeed.
Expand All @@ -18,7 +18,7 @@ Setting environment variables in your login profile, ``PIP_BREAK_SYSTEM_PACKAGES
The value of the environment variable can be any of ``1``, ``yes``, or ``true``.
The string values are not case sensitive.

``rosdep`` is designed to use ``sudo`` in order to gain root privileges for installation when not run as root.
rosdep is designed to use ``sudo`` in order to gain root privileges for installation when not run as root.
If your system's sudo configuration prohibits the passing of environment variables


Expand All @@ -44,15 +44,15 @@ Configuring for CI setup

Either environment variables or configuration files can be used with your CI system.
Which one you choose will depend on how your CI environment is configured.
Perhaps the most straightforward will be to set the environent variable in the shell or script execution context before invoking rosdep.
Perhaps the most straightforward will be to set the environent variable in the shell or script execution context before invoking ``rosdep``.

.. code-block:: bash
sudo rosdep init
rosdep update
PIP_BREAK_SYSTEM_PACKAGES=1 rosdep install -r rolling --from-paths src/
If rosdep is invoked by internal processes in your CI and you need to set the configuration without having direct control over how ``rosdep install`` is run, setting the environment variable globally would also work.
If ``rosdep`` is invoked by internal processes in your CI and you need to set the configuration without having direct control over how ``rosdep install`` is run, setting the environment variable globally would also work.

.. code-block:: bash
Expand Down

0 comments on commit 65c7152

Please sign in to comment.