Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Getting Started - tutorial changes.rst #959

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

alejandrojginerd
Copy link

I noticed I was able to build the project (getting started tutorial) without ccache installed. Therefore, every build took over 20 mins.

Description

Added a note in the tutorial for people to install ccache and reduce subsequent builds.

When following the tutorial, I notice that the build times were taking a lot >25 mins every time (even after hello_moveit tutorial). I added a note for people to install ccache in their system to reduce subsequent build times
Copy link
Contributor

@sea-bass sea-bass left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for this tip! While this works, I would bias towards using the more "official" colcon mixins workflow that is already documented earlier in this file.

You could for example do this instead:

colcon build --mixin release ccache

@@ -95,6 +95,17 @@ This build command will likely take a long time (20+ minutes) depending on your
If you are low on computer memory, or if the build is generally having trouble completing on your computer,
you can try appending ``--executor sequential`` to the ``colcon`` command above to build only one package at a time, or ``--parallel-workers <X>`` to limit the number of simultaneous builds. For even more limited machines, you can try running ``MAKEFLAGS="-j4 -l1" colcon build --executor sequential``.

.. note::

To greatly reduce the build time of subsecuent builds, make sure you have installed and properly configured ``ccache`` on your compiler.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To greatly reduce the build time of subsecuent builds, make sure you have installed and properly configured ``ccache`` on your compiler.
To greatly reduce the build time of subsequent builds, you can optionally set up ``ccache`` on your system.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants