From f1992db5e212d26354933f00bfab5b3727064ead Mon Sep 17 00:00:00 2001 From: Paul Romano Date: Fri, 13 Aug 2021 09:09:55 -0500 Subject: [PATCH] Mention that clang-format needs to be installed --- docs/source/devguide/styleguide.rst | 3 ++- docs/source/devguide/workflow.rst | 5 +++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/source/devguide/styleguide.rst b/docs/source/devguide/styleguide.rst index faeb37e230..44d80915e0 100644 --- a/docs/source/devguide/styleguide.rst +++ b/docs/source/devguide/styleguide.rst @@ -22,7 +22,8 @@ To ensure consistent styling with little effort, this project uses `clang-format ``.clang-format`` file that can be used to automatically apply a consistent format. The easiest way to use clang-format is to run ``tools/dev/install-commit-hooks.sh`` to install a post-commit hook that gets -executed each time a commit is made. In addition, you may want to configure your +executed each time a commit is made. Note that this script requires that you +already have clang-format installed. In addition, you may want to configure your editor/IDE to automatically runs clang-format using the ``.clang-format`` file whenever a file is saved. For example, `Visual Studio Code `_ includes diff --git a/docs/source/devguide/workflow.rst b/docs/source/devguide/workflow.rst index 44c0bbc5d5..57f2b1c68f 100644 --- a/docs/source/devguide/workflow.rst +++ b/docs/source/devguide/workflow.rst @@ -69,8 +69,9 @@ features and bug fixes. The general steps for contributing are as follows: 3. Run ``tools/dev/install-commit-hooks.sh`` to install a post-commit hook that runs clang-format on C++ files to apply :ref:`automatic code formatting - `. In addition, you may want to configure your text - editor to automatically run clang-format when saving C++ files. + ` (requires that clang-format already be installed). + In addition, you may want to configure your text editor to automatically run + clang-format when saving C++ files. 3. Make your changes on the new branch that you intend to have included in *develop*. If you have made other changes that should not be merged back,