From patchwork Thu Jul 30 12:35:39 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tom de Vries X-Patchwork-Id: 140238 Return-Path: X-Original-To: patchwork@sourceware.org Delivered-To: patchwork@sourceware.org Received: from vm01.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id DA0634B92096 for ; Thu, 30 Jul 2026 12:36:21 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org DA0634B92096 Authentication-Results: sourceware.org; dkim=pass (1024-bit key, unprotected) header.d=suse.de header.i=@suse.de header.a=rsa-sha256 header.s=susede2_rsa header.b=QRN8AEcT; dkim=pass header.d=suse.de header.i=@suse.de header.a=ed25519-sha256 header.s=susede2_ed25519 header.b=mNbIFg9d; dkim=pass (1024-bit key) header.d=suse.de header.i=@suse.de header.a=rsa-sha256 header.s=susede2_rsa header.b=ZXAct/u5; dkim=neutral header.d=suse.de header.i=@suse.de header.a=ed25519-sha256 header.s=susede2_ed25519 header.b=lQeB7PjI X-Original-To: gdb-patches@sourceware.org Delivered-To: gdb-patches@sourceware.org Received: from smtp-out1.suse.de (smtp-out1.suse.de [IPv6:2a07:de40:b251:101:10:150:64:1]) by sourceware.org (Postfix) with ESMTPS id 531A24BB58C4 for ; Thu, 30 Jul 2026 12:35:49 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 531A24BB58C4 Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=suse.de Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=suse.de ARC-Filter: OpenARC Filter v1.0.0 sourceware.org 531A24BB58C4 Authentication-Results: sourceware.org; arc=none smtp.remote-ip=2a07:de40:b251:101:10:150:64:1 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1785414949; cv=none; b=QSzxz9/OgN/Bq3CxUk/XDSR9ctnV8TTxWJMmf3xk5sqFPuBWYKE/e7JEetGhQpJUiQUfkt+C2f7EUg+OGNaDcrQMtbnEMc6kKx1gNdPB4OqIdJKdiLuHz4VEHcp7mwXPLtW/lxht+nE3ZexRi90hG8BeDndEb1YJnhtPrbwobyA= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1785414949; c=relaxed/simple; bh=BLRmiw0weLq1kFi2JbVwhLUllIs1sfRPenfA9KnQEfQ=; h=DKIM-Signature:DKIM-Signature:DKIM-Signature:DKIM-Signature:From: To:Subject:Date:Message-ID:MIME-Version; b=UBgyeebZMGT5xdTOjOH4/X7HEG5NS6GWcWMLE2czuhzNR3Yx2o1VobUYUDRyUnvcVRuTCZTxVI3uA1N0Jw68qLIyBCpp8Ut7/oReFds33DQbQAtcQG4sDeg0rAGM4IivCMDB7qxp1epW8c7P3/0flX0C9dDrE2iuC4J0G+1xFuM= ARC-Authentication-Results: i=1; sourceware.org; dkim=pass (1024-bit key, unprotected) header.d=suse.de header.i=@suse.de header.a=rsa-sha256 header.s=susede2_rsa header.b=QRN8AEcT; dkim=pass header.d=suse.de header.i=@suse.de header.a=ed25519-sha256 header.s=susede2_ed25519 header.b=mNbIFg9d; dkim=pass (1024-bit key) header.d=suse.de header.i=@suse.de header.a=rsa-sha256 header.s=susede2_rsa header.b=ZXAct/u5; dkim=neutral header.d=suse.de header.i=@suse.de header.a=ed25519-sha256 header.s=susede2_ed25519 header.b=lQeB7PjI DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 531A24BB58C4 Received: from imap1.dmz-prg2.suse.org (imap1.dmz-prg2.suse.org [IPv6:2a07:de40:b281:104:10:150:64:97]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by smtp-out1.suse.de (Postfix) with ESMTPS id 26D627D830 for ; Thu, 30 Jul 2026 12:35:40 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.de; s=susede2_rsa; t=1785414944; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc: mime-version:mime-version: content-transfer-encoding:content-transfer-encoding; bh=dYdvdP9bLxWiZgEip86+nXbhijosy8G6lU7sRddk7Gk=; b=QRN8AEcTvVs6giPp5zKt+bgyymoE5YEhOzaRyM45O9SprhPaG/1Q9fq8AhV+I4FUkQQqec Q8EN4Gs0iHQ5j4Doyz87zzkreVpp25Wi7j7dM9Gk5ArcvmJgTQ01XbTqfi1e2k0BlkzUYJ YZFe0Y7c/RLEkk3wkvJhKK+YuWl8Cpc= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=suse.de; s=susede2_ed25519; t=1785414944; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc: mime-version:mime-version: content-transfer-encoding:content-transfer-encoding; bh=dYdvdP9bLxWiZgEip86+nXbhijosy8G6lU7sRddk7Gk=; b=mNbIFg9dXa+62A96tOzjEfo6FG5vAsYxXewSowHZhfIkYdFgw3TlaV6qVtvH1X4DRnrLFa sHsMUC4ROCkfDXDw== Authentication-Results: smtp-out1.suse.de; dkim=pass header.d=suse.de header.s=susede2_rsa header.b="ZXAct/u5"; dkim=pass header.d=suse.de header.s=susede2_ed25519 header.b=lQeB7PjI DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.de; s=susede2_rsa; t=1785414940; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc: mime-version:mime-version: content-transfer-encoding:content-transfer-encoding; bh=dYdvdP9bLxWiZgEip86+nXbhijosy8G6lU7sRddk7Gk=; b=ZXAct/u50NmntpGwDL6zmS5fByGqKYDnS8yIRn8BIrgzUGwIF3ZZ4itMdsO+R2akKEydng gEQcbvQOZIl3SXQM5bdBdA3gThzA8mjc5pmQSgxmwoaxcdOlI92xdsajlDRoqxuHz7bj6T asLNsz3Nr11n+vZkmwdU+djWqb1QfhU= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=suse.de; s=susede2_ed25519; t=1785414940; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc: mime-version:mime-version: content-transfer-encoding:content-transfer-encoding; bh=dYdvdP9bLxWiZgEip86+nXbhijosy8G6lU7sRddk7Gk=; b=lQeB7PjIW0LS9AzIoWBGTJKI+HvI1Kr7DHIR0IpYGx90gjYYyzuZjiUpVsb9et8pT9DUu/ jyaOwrXtE0XAkWCQ== Received: from imap1.dmz-prg2.suse.org (localhost [127.0.0.1]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by imap1.dmz-prg2.suse.org (Postfix) with ESMTPS id 13416779CC for ; Thu, 30 Jul 2026 12:35:40 +0000 (UTC) Received: from dovecot-director2.suse.de ([2a07:de40:b281:106:10:150:64:167]) by imap1.dmz-prg2.suse.org with ESMTPSA id ap6AAxxFa2oyMAAAD6G6ig (envelope-from ) for ; Thu, 30 Jul 2026 12:35:40 +0000 From: Tom de Vries To: gdb-patches@sourceware.org Subject: [PATCH v3] [pre-commit] Add shellcheck Date: Thu, 30 Jul 2026 14:35:39 +0200 Message-ID: <20260730123539.24766-1-tdevries@suse.de> X-Mailer: git-send-email 2.51.0 MIME-Version: 1.0 X-Spamd-Result: default: False [-3.01 / 50.00]; BAYES_HAM(-3.00)[100.00%]; NEURAL_HAM_LONG(-1.00)[-1.000]; MID_CONTAINS_FROM(1.00)[]; R_MISSING_CHARSET(0.50)[]; NEURAL_HAM_SHORT(-0.20)[-1.000]; R_DKIM_ALLOW(-0.20)[suse.de:s=susede2_rsa,suse.de:s=susede2_ed25519]; MIME_GOOD(-0.10)[text/plain]; MX_GOOD(-0.01)[]; TO_MATCH_ENVRCPT_ALL(0.00)[]; ARC_NA(0.00)[]; RCVD_VIA_SMTP_AUTH(0.00)[]; RCPT_COUNT_ONE(0.00)[1]; MIME_TRACE(0.00)[0:+]; FROM_HAS_DN(0.00)[]; PREVIOUSLY_DELIVERED(0.00)[gdb-patches@sourceware.org]; FROM_EQ_ENVFROM(0.00)[]; DBL_BLOCKED_OPENRESOLVER(0.00)[suse.de:mid,suse.de:dkim,gnu.org:url,sourceware.org:url,imap1.dmz-prg2.suse.org:rdns,imap1.dmz-prg2.suse.org:helo]; DKIM_SIGNED(0.00)[suse.de:s=susede2_rsa,suse.de:s=susede2_ed25519]; RCVD_TLS_ALL(0.00)[]; TO_DN_NONE(0.00)[]; RCVD_COUNT_TWO(0.00)[2]; SPAMHAUS_XBL(0.00)[2a07:de40:b281:104:10:150:64:97:from]; DKIM_TRACE(0.00)[suse.de:+] X-Spam-Score: -3.01 X-Spam-Level: X-Rspamd-Queue-Id: 26D627D830 X-Rspamd-Server: rspamd2.dmz-prg2.suse.org X-Rspamd-Action: no action X-Spam-Status: No, score=-12.2 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, KAM_SHORT, SPF_HELO_NONE, SPF_PASS, TXREP shortcircuit=no autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on sourceware.org X-BeenThere: gdb-patches@sourceware.org X-Mailman-Version: 2.1.30 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: gdb-patches-bounces~patchwork=sourceware.org@sourceware.org Add a pre-commit shellcheck hook. Contrary to a usual pre-commit setup, users are expected to provide shellcheck themselves. Since that can be non-trival, as a compromise both versions 0.11.0 and 0.10.0 are allowed. This can lead to "but it works for me" situations, but people not using it because they don't have the latest version available seems worse. If version 0.10.0 is used, a note is emitted, though this is only visible with -v: .... $ pre-commit run shellcheck --all-files -v shellcheck...............................................................Passed - hook id: shellcheck - duration: 0.13s Using shellcheck version 0.10.0, but version 0.11.0 is preferred. ... Using shellcheck version 0.10.0, but version 0.11.0 is preferred. ... Alternative solutions are: - pureshellcheck [1]. Python, but the project seems unmaintained. - shellcheck-py [2]. Downloads an executable and runs it. - shellcheck-precommit [3]. Downloads a docker image and runs it. Changes in v3: - abandoned pureshellcheck approach used in v1 and v2. Versions: - v2 https://sourceware.org/pipermail/gdb-patches/2026-June/228145.html - v1 https://sourceware.org/pipermail/gdb-patches/2026-June/228118.html [1] https://github.com/adam2go/pureshellcheck [2] https://github.com/shellcheck-py/shellcheck-py [3] https://github.com/koalaman/shellcheck-precommit --- .pre-commit-config.yaml | 10 ++++++ gdb/contrib/shellcheck.sh | 65 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 75 insertions(+) create mode 100755 gdb/contrib/shellcheck.sh base-commit: 0d22d419a4b60672acf5555f5479fcf6956018a1 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 8ff84dae274..75eb1edd11d 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -147,3 +147,13 @@ repos: language: unsupported_script entry: gdb/contrib/check-file-mode.sh files: *gdb_files + - id: &id5 shellcheck + name: *id5 + files: '^(gdb|gdbsupport|gdbserver)/' + types: ['shell'] + language: unsupported_script + # The gdb/contrib/shellcheck.sh script requires shellcheck 0.11.0 + # (preferred) or 0.10.0. Not pinning this to a single version is a + # compromise to deal with the fact that users themselves need to + # provide the dependency, which may be non-trivial. + entry: gdb/contrib/shellcheck.sh diff --git a/gdb/contrib/shellcheck.sh b/gdb/contrib/shellcheck.sh new file mode 100755 index 00000000000..259988bec48 --- /dev/null +++ b/gdb/contrib/shellcheck.sh @@ -0,0 +1,65 @@ +#!/bin/bash + +# Copyright (C) 2026 Free Software Foundation, Inc. +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +version=$(shellcheck --version | grep ^version | awk '{print $2}') + +case "$version" in + 0.11.0) + # Preferred version. + true + ;; + 0.10.0) + # Allowed version, but mention preferred version. This will be + # visible with "pre-commit run shellcheck --all-files -v". + echo "Using shellcheck version 0.10.0, but version 0.11.0 is preferred." + ;; + *) + echo "Please install shellcheck version 0.11.0 (preferred) or 0.10.0" + exit 1 + ;; +esac + +files=() +for f in "$@"; do + case "$f" in + */configure) + # Skip generated files. + continue + ;; + gdb/config/djgpp/djcheck.sh \ + | gdb/config/djgpp/djconfig.sh \ + | gdb/contrib/cc-with-tweaks.sh \ + | gdb/contrib/gdb-add-index.sh \ + | gdb/gdb_buildall.sh \ + | gdb/gdb_mbuild.sh \ + | gdb/po/gdbtext \ + | gdb/regformats/regdat.sh \ + | gdb/testsuite/lib/pdtrace.in) + # Skip unclean files. + continue + ;; + *) + files=("${files[@]}" "$f") + ;; + esac +done + +if [ ${#files[@]} -eq 0 ]; then + # Nothing to do. + exit 0 +fi + +shellcheck "${files[@]}"