openstack/openstack-ansible
Code Issues Proposed changes

Add notes about bashate E006 exception

Browse Source 
bashate tests fail with 'E006: Line longer than 79 columns'.

As many scripts are deployed as templates and use jinja templating,
this rule is very difficult to achieve. It is still considered a
preference and should be a goal to improve readability, within reason.

Validation of this reasoning will be up to the human reviewers instead
of being forced by the lint tests.

Change-Id: I59cedad79814d51b7dc20610ee2eae38d7a83906
This commit is contained in:
Jesse Pretorius 2016-02-02 17:53:22 +00:00 committed by Jesse Pretorius (odyssey4me)
parent 410be5d6d6
commit b9eb3699de
2 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/developer-docs/scripts.rst
View File

@ -110,7 +110,11 @@ Testing may be done locally by executing:
Bash coding conventions are tested using `Bashate`_, with the following Bash coding conventions are tested using `Bashate`_, with the following
convention exceptions: convention exceptions:
* E003: Indent not multiple of 4 (we prefer to use multiples of 2) * E003: Indent not multiple of 4. We prefer to use multiples of 2 instead.
* E006: Line longer than 79 columns. As many scripts are deployed as templates
and use jinja templating, this is very difficult to achieve. It is
still considered a preference and should be a goal to improve
readability, within reason.
Testing may be done locally by executing: Testing may be done locally by executing:

3
tox.ini
View File

@ -55,7 +55,8 @@ commands =
# Run bashate check for all bash scripts # Run bashate check for all bash scripts
# Ignores the following rules: # Ignores the following rules:
# E003: Indent not multiple of 4 (we prefer to use multiples of 2) # E003: Indent not multiple of 4 (we prefer to use multiples of 2)
# E006: Line longer than 79 columns # E006: Line longer than 79 columns (as many scripts use jinja
# templating, this is very difficult)
bash -c "grep --recursive --binary-files=without-match \ bash -c "grep --recursive --binary-files=without-match \
--files-with-match '^.!.*\(ba\)\?sh$' \ --files-with-match '^.!.*\(ba\)\?sh$' \
--exclude-dir .tox \ --exclude-dir .tox \