doc/shfmt: Add note about minimal version of Bash

Signed-off-by: Michal Berger <michalx.berger@intel.com>
Change-Id: Id480d98cfe29f6c7676a39c0bfaf777ba54a6049
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/9371
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
This commit is contained in:
Michal Berger 2021-09-02 11:15:14 +02:00 committed by Keith Lucas
parent 3c39228b53
commit edaf193e21

View File

@ -15,6 +15,9 @@ formatter, shfmt, was introduced to help keep the .sh code consistent
across the entire repo. For more details on the tool itself, please see across the entire repo. For more details on the tool itself, please see
[shfmt](https://github.com/mvdan/sh). [shfmt](https://github.com/mvdan/sh).
We also advise to use 4.4 Bash as a minimum version to make sure scripts
across the whole repo work as intended.
## Usage {#shfmt_usage} ## Usage {#shfmt_usage}
On the CI pool, the shfmt is run against all the updated .sh files that On the CI pool, the shfmt is run against all the updated .sh files that