Skip to content

Commit 59b7e0b

Browse files
binitshahBinit Shahclalancette
authored
Clarifications to the Windows Foxy Binary Install (ros2#851)
* Include PowerShell in Win Install's Env Setup section * Cleared confusing wording around Win OpenSSL Install * Update Win GraphViz installation instructions * Use tab to include PowerShell equivalent + respect 1 sentence per line * Sourcing ROS on PowerShell startup * Update source file path to match windows install tutorial Co-authored-by: Chris Lalancette <[email protected]> * Replaced manual graphviz install with choco package Co-authored-by: Binit Shah <[email protected]> Co-authored-by: Chris Lalancette <[email protected]>
1 parent 5d17642 commit 59b7e0b

File tree

2 files changed

+27
-16
lines changed

2 files changed

+27
-16
lines changed

source/Installation/Foxy/Windows-Install-Binary.rst

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,12 @@ Scroll to the bottom of the page and download *Win64 OpenSSL v1.1.1g*.
5858
Don't download the Win32 or Light versions.
5959

6060
Run the installer with default parameters.
61-
The following commands assume you used the default installation directory:
61+
The following command sets an environment variable that persists over sessions.
62+
Modify the command to match your installation directory:
6263

6364
* ``setx -m OPENSSL_CONF C:\OpenSSL-Win64\bin\openssl.cfg``
6465

65-
You will need to append the OpenSSL-Win64 bin folder to your PATH.
66+
You will also need to append the OpenSSL-Win64 bin folder to your PATH.
6667
You can do this by clicking the Windows icon, typing "Environment Variables", then clicking on "Edit the system environment variables".
6768
In the resulting dialog, click "Environment Variables", then click "Path" on the bottom pane, finally click "Edit" and add the path below.
6869

@@ -136,7 +137,7 @@ Once these packages are downloaded, open an administrative shell and execute the
136137

137138
.. code-block:: bash
138139
139-
> choco install -y -s <PATH\TO\DOWNLOADS\> asio cunit eigen tinyxml-usestl tinyxml2 log4cxx bullet
140+
> choco install -y -s <PATH\TO\DOWNLOADS> asio cunit eigen tinyxml-usestl tinyxml2 log4cxx bullet
140141
141142
Please replace ``<PATH\TO\DOWNLOADS>`` with the folder you downloaded the packages to.
142143

@@ -155,19 +156,11 @@ RQt dependencies
155156
156157
.. _Foxy_windows-install-binary-installing-rqt-dependencies:
157158

158-
To run rqt_graph you need to `download <https://graphviz.gitlab.io/_pages/Download/Download_windows.html>`__ and install `Graphviz <https://graphviz.gitlab.io/>`__.
159-
160-
* The default installation path will be C:\Program Files (x86)\GraphvizX.XX\bin (Example: GraphvizX.XX → Graphviz2.38)
161-
* Open cmd window as administrator and go the location C:\Program Files (x86)\GraphvizX.XX\bin and run the below command:
159+
To run rqt_graph, you'll need `Graphviz <https://graphviz.gitlab.io/>`__.
162160

163161
.. code-block:: bash
164162
165-
dot.exe
166-
167-
* Go to the Control Panel → System and Security → System, and on the right side navigation panel, you will see the link Advanced systems settings.
168-
* Once there in advance settings, a dialogue box will open which will show the button Environment Variables. Click on the button Environment Variables.
169-
* Select the entry "Path" on the system variables section and add C:\Program Files (x86)\GraphvizX.XX\bin to the existing path.
170-
* Click on Ok Button.
163+
> choco install graphviz
171164
172165
Downloading ROS 2
173166
-----------------
@@ -190,9 +183,19 @@ Environment setup
190183

191184
Start a command shell and source the ROS 2 setup file to set up the workspace:
192185

193-
.. code-block:: bash
186+
.. tabs::
187+
188+
.. group-tab:: Command Prompt
189+
190+
.. code-block:: bash
191+
192+
> call C:\dev\ros2_foxy\local_setup.bat
193+
194+
.. group-tab:: PowerShell
195+
196+
.. code-block:: bash
194197
195-
> call C:\dev\ros2_foxy\local_setup.bat
198+
> C:\dev\ros2_foxy\local_setup.ps1
196199
197200
It is normal that the previous command, if nothing else went wrong, outputs "The system cannot find the path specified." exactly once.
198201

source/Tutorials/Configuring-ROS2-Environment.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,15 @@ If you don’t want to have to source the setup file every time you open a new s
9999
100100
.. group-tab:: Windows
101101

102-
Requires registry edits
102+
Only for PowerShell users, create a folder in 'My Documents' called 'WindowsPowerShell'.
103+
Within 'WindowsPowerShell', create file 'Microsoft.PowerShell_profile.ps1'.
104+
Inside the file, paste:
105+
106+
.. code-block:: console
107+
108+
C:\dev\ros2_foxy\local_setup.ps1
109+
110+
PowerShell will request permission to run this script everytime a new shell is opened.
103111

104112
To undo this (to change to another distro) in Linux and macOS, locate your system’s shell startup script and remove the appended source command.
105113

0 commit comments

Comments
 (0)