aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown/Contributing.md
diff options
context:
space:
mode:
authorJon Turney <jon.turney@dronecode.org.uk>2018-07-05 19:08:04 +0100
committerNirbheek Chauhan <nirbheek.chauhan@gmail.com>2018-07-05 18:08:04 +0000
commitb387ab1ee14915dc3d7a302a55f2a1b96f7615a8 (patch)
tree670c945ac5e3ee2b458e77a40cea94e286442562 /docs/markdown/Contributing.md
parent8893d03703affb0f8ae66fae84aa779a7992d86c (diff)
downloadmeson-b387ab1ee14915dc3d7a302a55f2a1b96f7615a8.zip
meson-b387ab1ee14915dc3d7a302a55f2a1b96f7615a8.tar.gz
meson-b387ab1ee14915dc3d7a302a55f2a1b96f7615a8.tar.bz2
Fix flake8 issues (#3834)
* Fix flake8 whitespace reports $ flake8 | grep -E '(E203|E221|E226|E303|W291|W293)' ./mesonbuild/coredata.py:337:5: E303 too many blank lines (2) * Fix flake8 'variable assigned value but unused' reports $ flake8 | grep -E F841 ./mesonbuild/modules/gnome.py:922:9: F841 local variable 'target_name' is assigned to but never used * Fix flake8 'imported but unused' reports $ flake8 | grep F401 ./mesonbuild/compilers/__init__.py:128:1: F401 '.c.ArmclangCCompiler' imported but unused ./mesonbuild/compilers/__init__.py:138:1: F401 '.cpp.ArmclangCPPCompiler' imported but unused ./mesonbuild/modules/__init__.py:4:1: F401 '..mlog' imported but unused PR #3717 imports ARMCLANG compilers in __init__, but does not add them to __all__, so they are not re-exported by the compilers package like everything else. * More details about flake8 in Contributing.md Mention that Sider runs flake8 Suggest seting flake8 as a pre-commit hook
Diffstat (limited to 'docs/markdown/Contributing.md')
-rw-r--r--docs/markdown/Contributing.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/markdown/Contributing.md b/docs/markdown/Contributing.md
index e385be2..c0eea29 100644
--- a/docs/markdown/Contributing.md
+++ b/docs/markdown/Contributing.md
@@ -167,6 +167,8 @@ Continuous integration systems currently used:
allows `[skip ci]` anywhere in the commit messages.
- [AppVeyor](https://www.appveyor.com/docs/how-to/filtering-commits/#skip-directive-in-commit-message)
requires `[skip ci]` or `[skip appveyor]` in the commit title.
+- [Sider](https://sider.review)
+ runs Flake8 (see below)
## Documentation
@@ -208,6 +210,13 @@ $ cd meson
$ flake8
```
+To run it automatically before committing:
+
+```console
+$ flake8 --install-hook=git
+$ git config --bool flake8.strict true
+```
+
## C/C++ coding style
Meson has a bunch of test code in several languages. The rules for