From 2a6e30c9c4b7d367d8be502e3444ee3768ea8db5 Mon Sep 17 00:00:00 2001 From: Assam Boudjelthia Date: Tue, 1 Jun 2021 16:03:55 +0300 Subject: [PATCH] Android: make the help print a bit easier to read and navigate Add new line between each argument type in the help print to make it easier to read and not a big wall of text. Change-Id: I7c7b2d2b59ef3a0889d1bb8c7af3d00b82bf820d Reviewed-by: Andy Shaw --- src/tools/androiddeployqt/main.cpp | 23 +++++++++++++++++++++-- src/tools/androidtestrunner/main.cpp | 19 ++++++++++++++----- 2 files changed, 35 insertions(+), 7 deletions(-) diff --git a/src/tools/androiddeployqt/main.cpp b/src/tools/androiddeployqt/main.cpp index ad007f1fcee..b3b7b169ca5 100644 --- a/src/tools/androiddeployqt/main.cpp +++ b/src/tools/androiddeployqt/main.cpp @@ -586,31 +586,41 @@ void printHelp() fprintf(stderr, "Syntax: %s --output [options]\n" "\n" " Creates an Android package in the build directory and\n" - " builds it into an .apk file.\n\n" + " builds it into an .apk file.\n" + "\n" " Optional arguments:\n" " --input : Reads for options generated by\n" " qmake. A default file name based on the current working\n" " directory will be used if nothing else is specified.\n" + "\n" " --deployment : Supported deployment mechanisms:\n" " bundled (default): Include Qt files in stand-alone package.\n" " ministro: Use the Ministro service to manage Qt files.\n" + "\n" " --aab: Build an Android App Bundle.\n" + "\n" " --no-build: Do not build the package, it is useful to just install\n" " a package previously built.\n" + "\n" " --install: Installs apk to device/emulator. By default this step is\n" " not taken. If the application has previously been installed on\n" " the device, it will be uninstalled first.\n" + "\n" " --reinstall: Installs apk to device/emulator. By default this step\n" " is not taken. If the application has previously been installed on\n" " the device, it will be overwritten, but its data will be left\n" " intact.\n" + "\n" " --device [device ID]: Use specified device for deployment. Default\n" " is the device selected by default by adb.\n" + "\n" " --android-platform : Builds against the given android\n" " platform. By default, the highest available version will be\n" " used.\n" + "\n" " --release: Builds a package ready for release. By default, the\n" " package will be signed with a debug key.\n" + "\n" " --sign : Signs the package with the\n" " specified keystore, alias and store password. Also implies the\n" " --release option.\n" @@ -631,30 +641,39 @@ void printHelp() " --protected: Keystore has protected authentication path.\n" " --jarsigner: Force jarsigner usage, otherwise apksigner will be\n" " used if available.\n" + "\n" " NOTE: To conceal the keystore information, the environment variables\n" " QT_ANDROID_KEYSTORE_PATH, and QT_ANDROID_KEYSTORE_ALIAS are used to\n" " set the values keysotore and alias respectively.\n" " Also the environment variables QT_ANDROID_KEYSTORE_STORE_PASS,\n" " and QT_ANDROID_KEYSTORE_KEY_PASS are used to set the store and key\n" " passwords respectively. This option needs only the --sign parameter.\n" + "\n" " --jdk : Used to find the jarsigner tool when used\n" " in combination with the --release argument. By default,\n" " an attempt is made to detect the tool using the JAVA_HOME and\n" " PATH environment variables, in that order.\n" + "\n" " --qml-import-paths: Specify additional search paths for QML\n" " imports.\n" + "\n" " --verbose: Prints out information during processing.\n" + "\n" " --no-generated-assets-cache: Do not pregenerate the entry list for\n" " the assets file engine.\n" + "\n" " --aux-mode: Operate in auxiliary mode. This will only copy the\n" " dependencies into the build directory and update the XML templates.\n" " The project will not be built or installed.\n" + "\n" " --apk : Path where to copy the built apk.\n" + "\n" " --qml-importscanner-binary : Override the\n" " default qmlimportscanner binary path. By default the\n" " qmlimportscanner binary is located using the Qt directory\n" " specified in the input file.\n" - " --help: Displays this information.\n\n", + "\n" + " --help: Displays this information.\n", qPrintable(QCoreApplication::arguments().at(0)) ); } diff --git a/src/tools/androidtestrunner/main.cpp b/src/tools/androidtestrunner/main.cpp index 37e58d52575..e0a69bb9cb6 100644 --- a/src/tools/androidtestrunner/main.cpp +++ b/src/tools/androidtestrunner/main.cpp @@ -264,23 +264,32 @@ static void printHelp() "\n" " Creates an Android package in a temp directory and\n" " runs it on the default emulator/device or on the one specified by\n" - " \"ANDROID_DEVICE_SERIAL\" environment variable.\n\n" + " \"ANDROID_DEVICE_SERIAL\" environment variable.\n" + "\n" " Mandatory arguments:\n" " --path : The path where androiddeployqt builds the android package.\n" + "\n" " --apk : The test apk path. The apk has to exist already, if it\n" - " does not exist the make command must be provided for building the apk.\n\n" + " does not exist the make command must be provided for building the apk.\n" + "\n" " Optional arguments:\n" " --make : make command, needed to install the qt library.\n" " For Qt 5.14+ this can be \"make apk\".\n" + "\n" " --adb : The Android ADB command. If missing the one from\n" " $PATH will be used.\n" + "\n" " --activity : The Activity to run. If missing the first\n" " activity from AndroidManifest.qml file will be used.\n" - " --timeout : Timeout to run the test.\n" - " Default is 5 minutes.\n" + "\n" + " --timeout : Timeout to run the test. Default is 5 minutes.\n" + "\n" " --skip-install-root: Do not append INSTALL_ROOT=... to the make command.\n" - " -- arguments that will be passed to the test application.\n" + "\n" + " -- Arguments that will be passed to the test application.\n" + "\n" " --verbose: Prints out information during processing.\n" + "\n" " --help: Displays this information.\n\n", qPrintable(QCoreApplication::arguments().at(0)) );