This minor release of bashate just fixes one small issue with python3
compatability. This is an alternative to
Ic91b5ce8cb85e376573f9bf3659d2a86cc437179.
Change-Id: Ie5ad29003cf80a332b9a9258749757a15de79966
This environment is used by the normal docs job, add it.
Manually add requirements needed for doc building.
Change-Id: I1be193d113683966f6a76e862713f3a550543168
This is a fairly opinionated change to do some spring cleaning on the
documentation.
The current output of shocco as rendered at [1] is completely broken.
I can not see that it is worth us maintaining this. Honestly, the
github page does a better job at showing the scripts with a bit of
formatting. The "changes" page is similarly useless today. cgit or
github show allow browsing of changes in the repo better. Both are
removed along with support scripts.
When you currently hit the first page, it gives no clue as to what
DevStack actually is. Add a paragraph explaining that, and link to
the cgit for easy source browsing.
stackrc.rst is not necessary; the stuff about database backends is
already discussed in configuration.rst; move the things about service
repos into a section of configuration.rst.
The discussion in openrc.rst is moved into the configuration.rst file.
localrc.conf.rst was just a paragraph pointing back to
configuration.rst; this is removed.
The variables described in exercise.rst are moved into a separate
section of configuration.rst
[1] http://docs.openstack.org/developer/devstack/#scripts
Change-Id: Ie7f4b265368f1d10a8908d75e11d625b2cc39e7c
Update bashate to 0.5.0 release. We got things ready for this with
I3fd5d55236e90c2f2c25243af87adaf0c1b763e2.
I'm not sure what I was thinking in
I9e4b1c0dc9e0f709d8e76f9c9bf1c9478b2605ed when I added ".orig" files
to the list of files to check. Ignore diff/merge files.
Change-Id: I8bb0c8b39972abb775b4e5556e79d2e17005bc8c
We don't have a new bashate release yet, but this fixes some minor
issues when used with bashate trunk.
The only two things triggered are stricter checking of assignment in
local declartions (catches quotes) and one instance of evaluating
arithmetic result in tools/xen/functions.
Therefore, hopefully, this change has no effect!
Change-Id: I3fd5d55236e90c2f2c25243af87adaf0c1b763e2
Update to bashate 0.4.0. The biggest change in this is that bashate
does a syntax check with "bash -n" which can be useful
Change-Id: Iff625ef2181dfaba28349dc17de0749faddec539
Latest tox causes failures:
File "/usr/local/lib/python2.7/dist-packages/tox/config.py", line 1140, in processcommand
argv = list(shlexer)
File "/usr/lib/python2.7/shlex.py", line 269, in next
token = self.get_token()
File "/usr/lib/python2.7/shlex.py", line 96, in get_token
raw = self.read_token()
File "/usr/lib/python2.7/shlex.py", line 172, in read_token
raise ValueError, "No closing quotation"
ValueError: No closing quotation
This is caused by a backwards incompatible change in tox:
https://bitbucket.org/hpk42/tox/issues/181
Change-Id: Ic28c634cf806394cfa82b61cb45be60b8f40a61a
Bashate 0.3.2 has a few new checks -- firstly make sure some of the
plugins have #!/bin/bash, and fix up a couple of "local" changes that
were missed by I9c8912a8fd596535589b207d7fc553b9d951d3fe
Change-Id: I9e4b1c0dc9e0f709d8e76f9c9bf1c9478b2605ed
I want to release a new bashate, but I also don't want to risk
consuming it before fully testing it. By pinning here, we can run all
our usual CI on new versions before accepting them.
Additionally, allow substitution of the bashate dependency via an
environment variable. We can use this in a bashate test to substitute
a path to a checkout with any changes applied.
Change-Id: I165c4d66db8b7bdcff235ef7d8c99029637bb76a
Since Ic2532676e46e93f129d590d1fa7a044ef65f50fb bashate warns on
long-lines. Traditionally, for whatever reason, devstack hasn't cared
too much about long lines unless it really damages readability.
So ignore this to avoid thousands of warnings on the long lines. Note
even though released bashate doesn't have this, ignoring a missing
test doesn't matter.
Change-Id: I16aeaa3b334fac1eec5085f2cfe26c81c53023a8
when running tox in a devstack directory where you have previously run tox
-edocs the bashate testenv will fail as the shocco code doesn't match the
devstack style.
eg:
---
E003: Indent not multiple of 4: ' 2>/dev/null ||'
- /home/stack/projects/openstack/openstack-dev/devstack/shocco/shocco.sh : L352
<snip>
27 bashate error(s) found
---
Take the easy path and avoid running bashate in the shocco dir.
Change-Id: I5b0155332ec994afaffc5c5961902281864cff61
there was a missing -or which meant we weren't running this on most of
the files in the repository.
Change-Id: If926afc8f12f6beb80d7a9af7c787b3dcc360a89
* config/INI functions from functions-common to to inc/ini-config
* local.conf meta-config functions from lib/config to inc/meta-config
Change-Id: I00fab724075a693529273878875cfd292d00b18a
Remove unnecessary old code from tools/build_docs.sh; it now only builds
docs for the current branch in the current working directory.
Fix the merging if the git log changes into changes.html.
Change-Id: I965dc3383b6317807ca0d47fe42648a19e96b57b
The current test does not match file files in /lib/* because the
-wholename command is missing the preceeding \*. The whole command is
a little difficult to understand.
This re-lays the find command, using -prune to skip dot directories
and keeping a hopefully clearer flow of what is being matched.
Change-Id: Idd856e897ff97095fb116294a9187ff4b198fa26
The motivation for this conversion is to have DevStack's docs be
generated using a more familair workflow for OpenStack projects, using
Sphinx.
Changing from raw HTML to RST will also make it easier to contribute
more documentation, as well as making edits less of a hassle.
The majority of the work was done by using Pandoc to convert from HTML
to RST, with minor edits to the output to remove errors in Sphinx.
Change-Id: I9636017965aeade37b950ddf5bdb0c22ab9004bd
As per the governance resolution https://review.openstack.org/119875,
projects should have a docs environment in their tox.ini testing
interface. Add one.
Change-Id: Ib3548bc23713e120089ae29b5c4e851de48cf8d3
Create a tox.ini file to install bashate into a virtualenv for running
tests. It can be run with a command such as "tox -v -ebashate". The find
command being used is equivalent to the default list of files discovered
by bashate plus the exclusion of the .tox/ directory. Also add the .tox/
directory to the .gitignore file.
Change-Id: I94cab4e4a9118d62edfce29ead1f1e2a5f48e529