summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlexander Batischev <eual.jp@gmail.com>2024-03-19 19:03:48 +0300
committerGitHub <noreply@github.com>2024-03-19 19:03:48 +0300
commit6124cd1867838511d4f4f8c0527f784d29acbfe4 (patch)
treefef2b735d221ac0af1fa054a18b3dcfb2b035c39
parent9d1edf9a0500eb52c74e9959882b198117cb2d79 (diff)
parentdf9d1cd39bbc0f24377bcd54e4bbd9cfe5786be7 (diff)
Merge pull request #2709 from danieloh0714/note-code-fmt-docker
add a note in the style guide for the code fmt dockerfile
-rw-r--r--doc/internal/code-style.markdown2
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/internal/code-style.markdown b/doc/internal/code-style.markdown
index 65508fe9..f65eca0a 100644
--- a/doc/internal/code-style.markdown
+++ b/doc/internal/code-style.markdown
@@ -23,6 +23,8 @@ Guidelines that could be easily automated, have been. Please install:
You can then run `make fmt` to format both C++ and Rust code.
+Note: If you are running into issues running `make fmt` locally, there is a lightweight Docker container available you can use to format. Instructions are in the [Docker file](../../docker/code-formatting-tools.dockerfile).
+
[editorconfig]: https://editorconfig.org/ "EditorConfig"
[astyle]: http://astyle.sourceforge.net/ "Artistic Style"