Commit 1d269b07 authored by Michal Berger's avatar Michal Berger Committed by Jim Harris
Browse files

doc/shfmt: Add note about minimal version of Bash 



Signed-off-by: default avatarMichal Berger <michalx.berger@intel.com>
Change-Id: Id480d98cfe29f6c7676a39c0bfaf777ba54a6049
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/9371


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
parent ab8b2579

doc/shfmt.md

+3 −0
Original line number Diff line number Diff line
@@ -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

[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}



On the CI pool, the shfmt is run against all the updated .sh files that