From 784f0cbcb14ed0d1990e8d3c7abce601c9899634 Mon Sep 17 00:00:00 2001 From: Oleg Alexandrov Date: Tue, 30 Nov 2021 14:33:08 -0800 Subject: [PATCH] Add clarification for .bashrc (#349) * Add clarification for .bashrc The configure.sh script modifies user's .bashrc. In my case it did it incorrectly, as the logic using "grep" it has can't distinguish commented out lines. This text makes it explicit that .bashrc is modified, and it suggests that the user examine the changes. * Add to NASA_INSTALL.md note about .bashrc modif --- doc/general_documentation/INSTALL.md | 4 ++++ doc/general_documentation/NASA_INSTALL.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/doc/general_documentation/INSTALL.md b/doc/general_documentation/INSTALL.md index 8d9dc61d8b..ef25d418c3 100644 --- a/doc/general_documentation/INSTALL.md +++ b/doc/general_documentation/INSTALL.md @@ -102,6 +102,10 @@ of turning on and off options. To see which options are supported, simply run source ~/.bashrc popd +The configure script modifies your ``.bashrc`` to source ``setup.bash`` for +the current ROS distribution and to set CMAKE_PREFIX_PATH. It is suggested +to examine it and see if all changes were made correctly. + If you want to explicitly specify the workspace and install directories, use instead: diff --git a/doc/general_documentation/NASA_INSTALL.md b/doc/general_documentation/NASA_INSTALL.md index 6f6811a33a..2a515262a8 100644 --- a/doc/general_documentation/NASA_INSTALL.md +++ b/doc/general_documentation/NASA_INSTALL.md @@ -173,6 +173,10 @@ of turning on and off options. To see which options are supported, simply run source ~/.bashrc popd +The configure script modifies your ``.bashrc`` to source ``setup.bash`` for +the current ROS distribution and to set CMAKE_PREFIX_PATH. It is suggested +to examine it and see if all changes were made correctly. + If you want to explicitly specify the workspace and/or install directories, use instead: