From: Kienan Stewart <kstewart@efficios.com>
Date: Mon, 12 Feb 2024 21:02:32 +0000 (-0500)
Subject: docs: coding style: shell scripts should be linted using shellcheck
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=9e433ef8b0414138c2df173f3300146616fd6c6f;p=lttng-tools.git

docs: coding style: shell scripts should be linted using shellcheck

Change-Id: I6532c73c2217918619a7d08d03a5a8da156beede
Signed-off-by: Kienan Stewart <kstewart@efficios.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
---

diff --git a/CodingStyle.md b/CodingStyle.md
index b1f5be1dd..ea9e9d2cb 100644
--- a/CodingStyle.md
+++ b/CodingStyle.md
@@ -267,6 +267,11 @@ Here are a couple of reminders:
 
 Python code should be formatted using [black](https://github.com/psf/black).
 
+## Shell (BASH)
+
+New scripts and modifications to existing scripts should pass linting
+with [Shellcheck](https://www.shellcheck.net/).
+
 ## C Style (historical)
 
 The coding style used for this project follows the the Linux kernel guide lines, except that brackets `{`, `}` should typically be used even for single-line if/else statements. Please refer to: