1BASH8(1)                             bash8                            BASH8(1)
2
3
4

NAME

6       bash8 - bash8
7
8       Contents:
9

BASH8

11       A pep8 equivalent for bash scripts
12
13       This program attempts to be an automated style checker for bash scripts
14       to fill the same part of code review that pep8 does in  most  OpenStack
15       projects.  It  started  from humble beginnings in the DevStack project,
16       and will continue to evolve over time.
17
18       · Free software: Apache license
19
20       · Documentation: http://docs.openstack.org/developer/bash8
21
22       · Source: http://git.openstack.org/cgit/openstack-dev/bash8
23
24       · Bugs: http://bugs.launchpad.net/bash8
25
26   Currently Supported Checks
27   Errors
28       Basic white space errors, for consistent indenting
29
30       · E001: check that lines do not end with trailing whitespace
31
32       · E002: ensure that indents are only spaces, and not hard tabs
33
34       · E003: ensure all indents are a multiple of 4 spaces
35
36       · E004: file did not end with a newline
37
38   Structure Errors
39       A set of rules that help keep  things  consistent  in  control  blocks.
40       These  are  ignored  on  long  lines  that have a continuation, because
41       unrolling that is kind of "interesting"
42
43       · E010: do not on the same line as for
44
45       · E011: then not on the same line as if
46
47       · E012: heredoc didn't end before EOF
48

INSTALLATION

50       At the command line:
51
52          $ pip install bash8
53
54       Or, if you have virtualenvwrapper installed:
55
56          $ mkvirtualenv bash8
57          $ pip install bash8
58

USAGE

60       To use bash8 in a project:
61
62          import bash8
63

CONTRIBUTING

65       If you would like to contribute to the development  of  OpenStack,  you
66       must  follow  the steps in the "If you're a developer, start here" sec‐
67       tion of this page:
68          http://wiki.openstack.org/HowToContribute
69
70       Once those steps have been completed, changes to  OpenStack  should  be
71       submitted  for review via the Gerrit tool, following the workflow docu‐
72       mented at:
73          http://wiki.openstack.org/GerritWorkflow
74
75       Pull requests submitted through GitHub will be ignored.
76
77       Bugs should be filed on Launchpad, not GitHub:
78          https://bugs.launchpad.net/bash8
79
80       · genindex
81
82       · modindex
83
84       · search
85

87       2013, OpenStack Foundation
88
89
90
91
92                                 Feb 02, 2019                         BASH8(1)
Impressum