summaryrefslogtreecommitdiffstats
path: root/util
diff options
context:
space:
mode:
authorJoerg Bornemann <joerg.bornemann@qt.io>2022-02-25 16:31:49 +0100
committerJoerg Bornemann <joerg.bornemann@qt.io>2022-02-28 15:41:22 +0100
commit268767e9a1eaba019e4c5eb8cf919a96779ceaac (patch)
tree6e846949bd5e3f732ce6e981b025e6f25d5ca625 /util
parentdece6f17e613b757530eb3d78c79dfaffb94f270 (diff)
pro2cmake: Update README.md
Mention that flake8 and black can be run via Makefile targets. Remove the outdated list of flake8 warnings. The Makefile ignores more warnings/errors, and it doesn't seem to be useful to duplicate this list here. Also remove the description of the black tool's arguments for the same reason. Change-Id: I941c3ab68b7a3d2477f7fbb5d28603987d0b2cab Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
Diffstat (limited to 'util')
-rw-r--r--util/cmake/README.md12
1 files changed, 3 insertions, 9 deletions
diff --git a/util/cmake/README.md b/util/cmake/README.md
index f8a6e9f540..a3e288ef04 100644
--- a/util/cmake/README.md
+++ b/util/cmake/README.md
@@ -39,22 +39,16 @@ python3.7 -m pip install -r requirements.txt
You can verify if the styling of a script is compliant with PEP8, with a couple of exceptions:
Install [flake8](http://flake8.pycqa.org/en/latest/) (`pip install flake8`) and run it
-on the script you want to test:
+on all python source files:
```
-flake8 <file>.py --ignore=E501,E266,W503
+make flake8
```
-* `E501`: Line too long (82>79 characters),
-* `E266`: Too many leading '#' for block comment,
-* `W503`: Line break occurred before a binary operator)
-
You can also modify the file with an automatic formatter,
like [black](https://black.readthedocs.io/en/stable/) (`pip install black`),
and execute it:
```
-black -l 100 <file>.py
+make format
```
-
-Using Qt's maximum line length, 100.