Skip to content

Commit 181dd9d

Browse files
mergify[bot]clalancettewilliamnavaraj
authored
Clarity on debug libraries further settings (backport ros2#2226) (ros2#2256)
* Clarity on debug libraries further settings (ros2#2226) People might waste hours/days trying to find out why their debug ros2 does not work while it is to do with missing python debug symbols and binaries. ros2/ros2#525 (comment) ros2/ros2#525 (comment) Co-authored-by: Chris Lalancette <[email protected]> (cherry picked from commit 0198e34) Co-authored-by: williamnavaraj <[email protected]>
1 parent 49df655 commit 181dd9d

File tree

5 files changed

+78
-2
lines changed

5 files changed

+78
-2
lines changed

source/Installation/Windows-Install-Binary.rst

Lines changed: 78 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ Instead you may download nightly :ref:`prerelease binaries <Prerelease_binaries>
3636

3737
.. note::
3838

39-
To download the ROS 2 debug libraries you'll need to download ``ros2-package-windows-debug-AMD64.zip``
39+
To install debug libraries for ROS 2, see `Extra Stuff for Debug`_.
40+
Then continue on with downloading ``ros2-package-windows-debug-AMD64.zip``.
4041

4142
* Unpack the zip file somewhere (we'll assume ``C:\dev\ros2_{DISTRO}``\ ).
4243

@@ -99,4 +100,79 @@ Uninstall
99100

100101
.. code-block:: bash
101102
102-
rmdir /s /q \ros2_{DISTRO}
103+
rmdir /s /q \ros2_{DISTRO}
104+
105+
Extra Stuff for Debug
106+
---------------------
107+
108+
To download the ROS 2 debug libraries you'll need to download ``ros2-{DISTRO}-*-windows-debug-AMD64.zip``.
109+
Please note that debug libraries require some more additional configuration/setup to work as given below.
110+
111+
Python installation may require modification to enable debugging symbols and debug binaries:
112+
113+
* Search in windows **Search Bar** and open **Apps and Features**.
114+
* Search for the installed Python version.
115+
116+
* Click Modify.
117+
118+
.. image:: images/python_installation_modify.png
119+
:width: 500 px
120+
121+
* Click Next to go to **Advanced Options**.
122+
123+
.. image:: images/python_installation_next.png
124+
:width: 500 px
125+
126+
* Make sure **Download debugging symbols** and **Download debug binaries** are checked.
127+
128+
.. image:: images/python_installation_enable_debug.png
129+
:width: 500 px
130+
131+
* Click Install.
132+
133+
(Alternative) ROS 2 Build Installation from aka.ms/ros
134+
--------------------------------------------------------
135+
136+
https://aka.ms/ros project hosts ROS 2 builds against the release snapshots.
137+
This section explains how to install ROS 2 from this channel.
138+
139+
Install ROS 2 builds
140+
^^^^^^^^^^^^^^^^^^^^
141+
142+
In an administrative command prompt, run the following commands.
143+
144+
.. code-block:: bash
145+
146+
mkdir c:\opt\chocolatey
147+
set PYTHONNOUSERSITE=1
148+
set ChocolateyInstall=c:\opt\chocolatey
149+
choco source add -n=ros-win -s="https://aka.ms/ros/public" --priority=1
150+
choco upgrade ros-foxy-desktop -y --execution-timeout=0
151+
152+
Environment setup
153+
^^^^^^^^^^^^^^^^^^
154+
155+
Start an administrative command prompt and source the ROS 2 setup file to set up the workspace:
156+
157+
.. code-block:: bash
158+
159+
call C:\opt\ros\foxy\x64\local_setup.bat
160+
161+
Stay up-to-date
162+
^^^^^^^^^^^^^^^
163+
164+
To keep up-to-date with the latest builds, run:
165+
166+
.. code-block:: bash
167+
168+
set ChocolateyInstall=c:\opt\chocolatey
169+
choco upgrade all -y --execution-timeout=0
170+
171+
Uninstall
172+
^^^^^^^^^
173+
174+
If you want to completely remove the environment downloaded above, run this command:
175+
176+
.. code-block:: bash
177+
178+
rmdir /s /q C:\opt\
182 KB
Loading
9.29 KB
Loading
169 KB
Loading
75.4 KB
Loading

0 commit comments

Comments
 (0)