From 4907d64958d5f2d3c2ae32f9c173a40c72348b35 Mon Sep 17 00:00:00 2001 From: Ryan Friedman <25047695+Ryanf55@users.noreply.github.com> Date: Sat, 21 Sep 2024 12:31:26 -0600 Subject: [PATCH] dev: Document astyle python script Signed-off-by: Ryan Friedman <25047695+Ryanf55@users.noreply.github.com> --- dev/source/docs/style-guide.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) 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 ====