From: "flichtenheld (Code Review)" Date: Fri, 27 Jun 2025 09:39:46 +0000 References: Reply-To: frank@...2641..., arne-openvpn@...1227..., openvpn-devel@lists.sourceforge.net Message-ID: <055ad6137ade574a852e723b60fbb431a65d1a9a-HTML@...2715...> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Disposition: inline Content-Type: multipart/alternative; boundary="RoyvaWhIkhs="; charset=UTF-8 Subject: [Openvpn-devel] [S] Change in openvpn[master]: Update git-pre-commit-uncrustify.sh to handle clang-format List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: plaisthos Cc: openvpn-devel --RoyvaWhIkhs= Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Attention is currently required from: plaisthos. Hello plaisthos, I'd like you to do a code review. Please visit http://gerrit.openvpn.net/c/openvpn/+/1070?usp=3Demail to review the following change. Change subject: Update git-pre-commit-uncrustify.sh to handle clang-format ...................................................................... Update git-pre-commit-uncrustify.sh to handle clang-format Rename it as well, since it is not specific to uncrustify anymore. Change-Id: I03195c21807cdef0a2f903f424982ec29a555103 Signed-off-by: Frank Lichtenheld --- R dev-tools/git-pre-commit-format.sh 1 file changed, 32 insertions(+), 14 deletions(-) git pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/70/1070/1 diff --git a/dev-tools/git-pre-commit-uncrustify.sh b/dev-tools/git-pre-com= mit-format.sh similarity index 81% rename from dev-tools/git-pre-commit-uncrustify.sh rename to dev-tools/git-pre-commit-format.sh index 9851c21..6e1ac71 100755 --- a/dev-tools/git-pre-commit-uncrustify.sh +++ b/dev-tools/git-pre-commit-format.sh @@ -2,6 +2,7 @@ # Copyright (c) 2015, David Martin # 2022, Heiko Hund +# 2025, Frank Lichtenheld # All rights reserved. # # Redistribution and use in source and binary forms, with or without @@ -26,10 +27,12 @@ # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -# git pre-commit hook that runs an Uncrustify stylecheck. +# git pre-commit hook that runs a stylecheck. # Features: # - abort commit when commit does not comply with the style guidelines # - create a patch of the proposed style changes +# - use clang-format or uncrustify depending on presence of .clang-format +# config file # # More info on Uncrustify: http://uncrustify.sourceforge.net/ @@ -77,27 +80,42 @@ against=3D4b825dc642cb6eb9a060e54bf8d69288fbee4904 fi -UNCRUSTIFY=3D$(command -v uncrustify) -UNCRUST_CONFIG=3D"$(git rev-parse --show-toplevel)/dev-tools/uncrustify.co= nf" +TOPDIR=3D"$(git rev-parse --show-toplevel)" +if [ -e "${TOPDIR}/.clang-format" ]; then + TOOL=3Dclang-format + TOOL_BIN=3D$(command -v clang-format) + TOOL_CMD=3D"$TOOL_BIN" -# make sure the config file and executable are correctly set -if [ ! -f "$UNCRUST_CONFIG" ] ; then - printf "Error: uncrustify config file not found.\n" - printf "Expected to find it at $UNCRUST_CONFIG.\n" - printf "Aborting commit.\n" - exit 1 + # Allow to use in parallel with pre-commit + if [ $(basename "$0") =3D "pre-commit.legacy" ]; then + echo "Skipping clang-format check in favor of pre-commit" + exit 0 + fi +else + TOOL=3Duncrustify + TOOL_BIN=3D$(command -v uncrustify) + UNCRUST_CONFIG=3D"${TOPDIR}/dev-tools/uncrustify.conf" + TOOL_CMD=3D"$TOOL_BIN -q -l C -c $UNCRUST_CONFIG" + + # make sure the config file is correctly set + if [ ! -f "$UNCRUST_CONFIG" ] ; then + printf "Error: uncrustify config file not found.\n" + printf "Expected to find it at $UNCRUST_CONFIG.\n" + printf "Aborting commit.\n" + exit 1 + fi fi -if [ -z "$UNCRUSTIFY" ] ; then - printf "Error: uncrustify executable not found.\n" +if [ -z "$TOOL_BIN" ] ; then + printf "Error: $TOOL executable not found.\n" printf "Is it installed and in your \$PATH?\n" printf "Aborting commit.\n" exit 1 fi # create a filename to store our generated patch -patch=3D$(mktemp /tmp/ovpn-fmt-XXXXXX) -tmpout=3D$(mktemp /tmp/uncrustify-XXXXXX) +patch=3D$(mktemp /tmp/ovpn-fmt-patch-XXXXXX) +tmpout=3D$(mktemp /tmp/ovpn-fmt-tmp-XXXXXX) # create one patch containing all changes to the files # sed to remove quotes around the filename, if inserted by the system @@ -131,7 +149,7 @@ # +++ $tmpout timestamp # to both lines working on the same file and having a a/ and b/ prefix. # Else it can not be applied with 'git apply'. - git show ":$file" | "$UNCRUSTIFY" -q -l C -c "$UNCRUST_CONFIG" -o "$tm= pout" + git show ":$file" | $TOOL_CMD > "$tmpout" git show ":$file" | diff -u -- - "$tmpout" | \ sed -e "1s|--- -|--- \"b/$file_escaped_target\"|" -e "2s|+++ $tmpo= ut|+++ \"a/$file_escaped_target\"|" >> "$patch" done -- To view, visit http://gerrit.openvpn.net/c/openvpn/+/1070?usp=3Demail To unsubscribe, or for help writing mail filters, visit http://gerrit.openv= pn.net/settings Gerrit-Project: openvpn Gerrit-Branch: master Gerrit-Change-Id: I03195c21807cdef0a2f903f424982ec29a555103 Gerrit-Change-Number: 1070 Gerrit-PatchSet: 1 Gerrit-Owner: flichtenheld Gerrit-Reviewer: plaisthos Gerrit-CC: openvpn-devel Gerrit-Attention: plaisthos Gerrit-MessageType: newchange --RoyvaWhIkhs= Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable

Attention is currently required from: plaisthos.

flichtenheld would like plaisthos to review this change.

V= iew Change

Update git-pre-commit-uncrustify.sh to handle clang-format
Rename it as well, since it is not specific to
uncrustify anymore.=

Change-Id: I03195c21807cdef0a2f903f424982ec29a555103
Signed-off-= by: Frank Lichtenheld <frank@...2641...>
---
R dev-tools/git-pr= e-commit-format.sh
1 file changed, 32 insertions(+), 14 deletions(-)
=
git pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/70/1070=
/1
diff --git a/dev-tools/git-pre-commit-uncrustify.sh b/dev-tools/=
git-pre-commit-format.sh
similarity index 81%
rename from dev-tools/git-pre-commit-uncrustify.sh
renam= e to dev-tools/git-pre-commit-format.sh
index 9851c21..6e1a= c71 100755
--- a/dev-tools/git-pre-commit-uncrustify.sh

+++ b/dev-tools/git-pre-commit-format.sh
@@ -2= ,6 +2,7 @@

# Copyright (c) 2015, David M= artin
# 2022, Heiko Hund
+# 2025, Frank Lichtenheld=
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
@@ -26,10 +27,12 @@
# OF THIS SOFTWARE, EVEN I= F ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


-# git pre-commit= hook that runs an Uncrustify stylecheck.
+# git pre-commit hook that runs a stylecheck.<= br> # Features:
# - abort commit when commit does n= ot comply with the style guidelines
# - create a patch of= the proposed style changes
+# - use clang-format or uncrustify depending on presence of .clang= -format
+# config = file
#
# More info on Uncrustify: http://= uncrustify.sourceforge.net/

@@ -77,27 +80= ,42 @@
against=3D4b825dc642cb6eb9a060e54bf8d69288fbee4= 904
fi

-UNCRUSTIFY=3D$(command -v uncrustify)
-UNCRUST_CONFIG=3D"$(git rev-parse = --show-toplevel)/dev-tools/uncrustify.conf"
+TOPDIR=3D"$(git rev-parse --show-toplevel= )"
+if [ -e &quo= t;${TOPDIR}/.clang-format" ]; then
+ TOOL=3Dclang-format
+ TOOL_BIN=3D$(command -v clang-format)+ TOOL_CMD=3D"$TOOL_BI= N"

-# make sure the config file and executable are correctly set
= -if [ ! -f "$UNCRUST_CONFIG&= quot; ] ; then
- pri= ntf "Error: uncrustify config file not found.\n"
- printf "Expected to find it a= t $UNCRUST_CONFIG.\n"
- printf "Aborting commit.\n"
- exit 1
+ # Allow to use in parallel with pre-commit
+ if [ $(basename "$0&quo= t;) =3D "pre-commit.legacy" ]; then
+ echo "Skipping clang-format check in = favor of pre-commit"
+ exit 0
+= fi
+else+ TOOL=3Duncrustify=
+ TOOL_BIN=3D$(command -= v uncrustify)
+ UN= CRUST_CONFIG=3D"${TOPDIR}/dev-tools/uncrustify.conf"
+ TOOL_CMD=3D"$TOOL_BIN -= q -l C -c $UNCRUST_CONFIG"
+
+ # m= ake sure the config file is correctly set
+ if [ ! -f "$UNCRUST_CONFIG" ] ; then

+ printf "E= rror: uncrustify config file not found.\n"
+ printf "Expected to find it at $UN= CRUST_CONFIG.\n"
+ printf "Aborting commit.\n"
+ exit 1
+ fi
fi
<= br>-if [ -z "$UNCRUSTIFY&quo= t; ] ; then
- printf= "Error: uncrustify executable not found.\n"
+if [ -z "$TOOL_BIN" ] ; then
+ printf "Erro= r: $TOOL executable not found.\n"
printf "Is= it installed and in your \$PATH?\n"
printf "= ;Aborting commit.\n"
exit 1
fi

# create a filename to store our generate= d patch
-patch=3D$(mkte= mp /tmp/ovpn-fmt-XXXXXX)
+patch=3D$(mktemp /tmp/ovpn-fmt-patch-XXXXXX)

+tmpout=3D$(mktemp /tmp/ov= pn-fmt-tmp-XXXXXX)

# create one patch co= ntaining all changes to the files
# sed to remove quotes a= round the filename, if inserted by the system
@@ -131,7 +14= 9,7 @@
# +++ $tmpout timestamp
= # to both lines working on the same file and having a a/ and b/ prefix.
# Else it can not be applied with 'git apply'.
- git show ":$fi= le" | "$UNCRUSTIFY" -q -l C -c "$UNCRUST_CONFIG" -= o "$tmpout"
+ git show ":$file" | $TOOL_CMD > "$tmpout"
git show ":$file" | diff -u -- - "$tmpout&q= uot; | \
sed -e "1s|--- -|--- \"b/$file_= escaped_target\"|" -e "2s|+++ $tmpout|+++ \"a/$file_esc= aped_target\"|" >> "$patch"
done=

To view, visit change 1070. To unsubscribe= , or for help writing mail filters, visit settings.

Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: I03195c21807cdef0a2f903f4249= 82ec29a555103
Gerrit-Change-Number: 1070
Gerrit-PatchSet: 1
Gerrit-Owner: flichtenheld <frank@...2723...= .>
Gerrit-Reviewer: plaisthos <arne-openvpn@...1186...= .1227...>
Gerrit-CC: openvpn-devel <openvpn-devel@...1484...= ts.sourceforge.net>
Gerrit-Attention: plaisthos <arne-openvpn@...220...= ..1227...>
Gerrit-MessageType: newchange
--RoyvaWhIkhs=--