From a8f23181697854d5770f317b81b02582dea3dcb1 Mon Sep 17 00:00:00 2001
From: Nickolay Olshevsky <o.nickolay@gmail.com>
Date: Thu, 23 May 2024 16:59:55 +0300
Subject: [PATCH] Update docs with command line for clang-format from
 clang-format-lint-action.

---
 docs/develop.adoc | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/docs/develop.adoc b/docs/develop.adoc
index df267c589..e91938a9f 100644
--- a/docs/develop.adoc
+++ b/docs/develop.adoc
@@ -258,6 +258,8 @@ docker commit clang-format clang-format
 docker rm clang-format
 --
 
+How to use pre-built docker container from the linter action please see below.
+
 You can then reformat a file (say, `src/lib/crypto/bn.cpp`) like so:
 
 [source,console]
@@ -280,6 +282,29 @@ docker run --rm -v $PWD:/rnp -w /rnp clang-format clang-format -style=file -i `g
 docker run --rm -v $PWD:/rnp -w /rnp clang-format clang-format -style=file -i `git diff --name-only 54c5476..HEAD |grep "\.\(c\|h\|cpp\)\$"`
 --
 
+==== clang-format (manually, using the docker container from the clang-format-lint-action)
+
+Build container:
+
+[source,console]
+--
+docker build -t clang-format-lint github.com/DoozyX/clang-format-lint-action
+--
+
+Get a diff with formatting errors:
+
+[source,console]
+--
+docker run -it --rm --workdir /src -v $(pwd):/src clang-format-lint --clang-format-executable /clang-format/clang-format11.0.0 -r --exclude .git .
+--
+
+To edit files in-place, fixing the formatting errors, you should add `--inplace` parameter:
+
+[source,console]
+--
+docker run -it --rm --workdir /src -v $(pwd):/src clang-format-lint --clang-format-executable /clang-format/clang-format11.0.0 -r --exclude .git . --inplace true
+--
+
 === Style Guide
 
 In order to keep the code base consistent, we should define and adhere