diff --git a/dev/source/docs/style-guide.rst b/dev/source/docs/style-guide.rst index 687a12e44d..fa05f4dafb 100644 --- a/dev/source/docs/style-guide.rst +++ b/dev/source/docs/style-guide.rst @@ -21,8 +21,15 @@ automatically according to the guidelines below. astyle --options=Tools/CodeStyle/astylerc +Some files are enforced to be *astyle* clean. To format them automatically, run: + +:: + + ./Tools/scripts/run_astyle.py + Remember any formatting changes to a file should be done as a separate -commit. +commit. You can add formatting commits to the ``.git-blame-ignore-revs`` file +to not clutter history. Case ====