qt5base-lts/util/cmake
Simon Hausmann f4aa7255e6 Fix casing of public API functions
Use lower case for the function name as that's cmake style.

Change-Id: I6c53166aa3a8cece4abe8a485e06bd359fc12a06
Reviewed-by: Leander Beernaert <leander.beernaert@qt.io>
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
Reviewed-by: Qt CMake Build Bot
2019-09-19 08:01:05 +00:00
..
tests Add support for converting qtTargetLibrary() value assignments 2019-08-08 13:03:28 +00:00
cmakeconversionrate.py Improve styling of util/cmake scripts 2019-09-18 12:00:26 +00:00
configurejson2cmake.py Improve styling of util/cmake scripts 2019-09-18 12:00:26 +00:00
generate_module_map.sh Begin port of qtbase to CMake 2018-11-01 11:48:46 +00:00
helper.py Add SDL2 to 3rd-party library mapping 2019-09-18 19:14:25 +00:00
json_parser.py Improve styling of util/cmake scripts 2019-09-18 12:00:26 +00:00
Pipfile CMake: pro2cmake.py: Simplify conditions 2019-01-29 09:29:38 +00:00
pro2cmake.py Fix casing of public API functions 2019-09-19 08:01:05 +00:00
pro_conversion_rate.py Improve styling of util/cmake scripts 2019-09-18 12:00:26 +00:00
README.md Improve styling of util/cmake scripts 2019-09-18 12:00:26 +00:00
requirements.txt Improve styling of util/cmake scripts 2019-09-18 12:00:26 +00:00
run_pro2cmake.py Add option to generate pro2cmake on failed ones 2019-09-18 14:02:22 +00:00
special_case_helper.py Improve styling of util/cmake scripts 2019-09-18 12:00:26 +00:00

CMake Utils

This directory holds scripts to help the porting process from qmake to cmake for Qt6.

Requirements

  • Python 3.7,
  • pipenv or pip to manage the modules.

Python modules

Since Python has many ways of handling projects, you have a couple of options to install the dependencies of the scripts:

Using pipenv

The dependencies are specified on the Pipfile, so you just need to run pipenv install and that will automatically create a virtual environment that you can activate with a pipenv shell.

Using pip

It's highly recommended to use a virtualenvironment to avoid conflict with other packages that are already installed: pip install virtualenv.

  • Create an environment: virtualenv env,
  • Activate the environment: source env/bin/activate (on Windows: source env\Scripts\activate.bat)
  • Install the requirements: pip install -r requirements.txt

Contributing to the scripts

You can verify if the styling of a script complaint with PEP8, with a couple of exceptions:

Install flake8 (pip install flake8) and run it on the script you want to test:

flake8 <file>.py --ignore=E501,E266,W503
  • 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 (pip install black), and execute it:

black -l 100 <file>.py

Using Qt's maximum line length, 100.