diff options
author | 2019-07-10 13:59:50 +0200 | |
---|---|---|
committer | 2019-07-10 14:23:48 +0000 | |
commit | 36d56bdb7f9f394047e2df3f29bf47db877b649c (patch) | |
tree | de01e08334759f2f41b30dabcbd179b94015b0e0 /docs/cpta/methodology | |
parent | e45404bf7b8cbdb10adf85815c2e005134e463ad (diff) |
Bash functions style cleanup
+ Update rst documentation for bash style
+ Command substitution:
+ Clarify when to use backticks.
+ Recommend avoiding nested command substitution.
+ Do not recommend putting command substitution results into quotes.
+ Function definition content:
+ Move "set -exuo pipefail" after comment only blocks.
+ Other set flags allowed for functions with good reasons.
+ Apply the new recommendations.
- Blank lines unified in code but no written recommendation in rst.
+ Add missing references to functions called, variables read or set.
+ Add TODOs to where lists would be long.
+ Minor improvements to function descriptions.
+ Make "if" expressions more python-like.
+ Add missing "|| die" (or "|| true") where spotted.
+ Downgrade DEFAULT_NIC to a local variable.
+ Add TODO to list reasons for blacklisted tags.
Change-Id: I05dce030a8c2cb1b3a242d8b977e8fe150d8ee20
Signed-off-by: Vratko Polak <vrpolak@cisco.com>
Diffstat (limited to 'docs/cpta/methodology')
0 files changed, 0 insertions, 0 deletions