1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Android: make the help print a bit easier to read and navigate

Browse Source 
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 <andy.shaw@qt.io>
This commit is contained in:
Assam Boudjelthia 2021-06-01 16:03:55 +03:00
parent 2c49f85380
commit 2a6e30c9c4
2 changed files with 35 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/tools/androiddeployqt/main.cpp
View File

@ -586,31 +586,41 @@ void printHelp()
fprintf(stderr, "Syntax: %s --output <destination> [options]\n" fprintf(stderr, "Syntax: %s --output <destination> [options]\n"
"\n" "\n"
" Creates an Android package in the build directory <destination> and\n" " Creates an Android package in the build directory <destination> and\n"
" builds it into an .apk file.\n\n" " builds it into an .apk file.\n"
"\n"
" Optional arguments:\n" " Optional arguments:\n"
" --input <inputfile>: Reads <inputfile> for options generated by\n" " --input <inputfile>: Reads <inputfile> for options generated by\n"
" qmake. A default file name based on the current working\n" " qmake. A default file name based on the current working\n"
" directory will be used if nothing else is specified.\n" " directory will be used if nothing else is specified.\n"
"\n"
" --deployment <mechanism>: Supported deployment mechanisms:\n" " --deployment <mechanism>: Supported deployment mechanisms:\n"
" bundled (default): Include Qt files in stand-alone package.\n" " bundled (default): Include Qt files in stand-alone package.\n"
" ministro: Use the Ministro service to manage Qt files.\n" " ministro: Use the Ministro service to manage Qt files.\n"
"\n"
" --aab: Build an Android App Bundle.\n" " --aab: Build an Android App Bundle.\n"
"\n"
" --no-build: Do not build the package, it is useful to just install\n" " --no-build: Do not build the package, it is useful to just install\n"
" a package previously built.\n" " a package previously built.\n"
"\n"
" --install: Installs apk to device/emulator. By default this step is\n" " --install: Installs apk to device/emulator. By default this step is\n"
" not taken. If the application has previously been installed on\n" " not taken. If the application has previously been installed on\n"
" the device, it will be uninstalled first.\n" " the device, it will be uninstalled first.\n"
"\n"
" --reinstall: Installs apk to device/emulator. By default this step\n" " --reinstall: Installs apk to device/emulator. By default this step\n"
" is not taken. If the application has previously been installed on\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" " the device, it will be overwritten, but its data will be left\n"
" intact.\n" " intact.\n"
"\n"
" --device [device ID]: Use specified device for deployment. Default\n" " --device [device ID]: Use specified device for deployment. Default\n"
" is the device selected by default by adb.\n" " is the device selected by default by adb.\n"
"\n"
" --android-platform <platform>: Builds against the given android\n" " --android-platform <platform>: Builds against the given android\n"
" platform. By default, the highest available version will be\n" " platform. By default, the highest available version will be\n"
" used.\n" " used.\n"
"\n"
" --release: Builds a package ready for release. By default, the\n" " --release: Builds a package ready for release. By default, the\n"
" package will be signed with a debug key.\n" " package will be signed with a debug key.\n"
"\n"
" --sign <url/to/keystore> <alias>: Signs the package with the\n" " --sign <url/to/keystore> <alias>: Signs the package with the\n"
" specified keystore, alias and store password. Also implies the\n" " specified keystore, alias and store password. Also implies the\n"
" --release option.\n" " --release option.\n"
@ -631,30 +641,39 @@ void printHelp()
" --protected: Keystore has protected authentication path.\n" " --protected: Keystore has protected authentication path.\n"
" --jarsigner: Force jarsigner usage, otherwise apksigner will be\n" " --jarsigner: Force jarsigner usage, otherwise apksigner will be\n"
" used if available.\n" " used if available.\n"
"\n"
" NOTE: To conceal the keystore information, the environment variables\n" " NOTE: To conceal the keystore information, the environment variables\n"
" QT_ANDROID_KEYSTORE_PATH, and QT_ANDROID_KEYSTORE_ALIAS are used to\n" " QT_ANDROID_KEYSTORE_PATH, and QT_ANDROID_KEYSTORE_ALIAS are used to\n"
" set the values keysotore and alias respectively.\n" " set the values keysotore and alias respectively.\n"
" Also the environment variables QT_ANDROID_KEYSTORE_STORE_PASS,\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" " 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" " passwords respectively. This option needs only the --sign parameter.\n"
"\n"
" --jdk <path/to/jdk>: Used to find the jarsigner tool when used\n" " --jdk <path/to/jdk>: Used to find the jarsigner tool when used\n"
" in combination with the --release argument. By default,\n" " in combination with the --release argument. By default,\n"
" an attempt is made to detect the tool using the JAVA_HOME and\n" " an attempt is made to detect the tool using the JAVA_HOME and\n"
" PATH environment variables, in that order.\n" " PATH environment variables, in that order.\n"
"\n"
" --qml-import-paths: Specify additional search paths for QML\n" " --qml-import-paths: Specify additional search paths for QML\n"
" imports.\n" " imports.\n"
"\n"
" --verbose: Prints out information during processing.\n" " --verbose: Prints out information during processing.\n"
"\n"
" --no-generated-assets-cache: Do not pregenerate the entry list for\n" " --no-generated-assets-cache: Do not pregenerate the entry list for\n"
" the assets file engine.\n" " the assets file engine.\n"
"\n"
" --aux-mode: Operate in auxiliary mode. This will only copy the\n" " --aux-mode: Operate in auxiliary mode. This will only copy the\n"
" dependencies into the build directory and update the XML templates.\n" " dependencies into the build directory and update the XML templates.\n"
" The project will not be built or installed.\n" " The project will not be built or installed.\n"
"\n"
" --apk <path/where/to/copy/the/apk>: Path where to copy the built apk.\n" " --apk <path/where/to/copy/the/apk>: Path where to copy the built apk.\n"
"\n"
" --qml-importscanner-binary <path/to/qmlimportscanner>: Override the\n" " --qml-importscanner-binary <path/to/qmlimportscanner>: Override the\n"
" default qmlimportscanner binary path. By default the\n" " default qmlimportscanner binary path. By default the\n"
" qmlimportscanner binary is located using the Qt directory\n" " qmlimportscanner binary is located using the Qt directory\n"
" specified in the input file.\n" " specified in the input file.\n"
" --help: Displays this information.\n\n", "\n"
" --help: Displays this information.\n",
qPrintable(QCoreApplication::arguments().at(0)) qPrintable(QCoreApplication::arguments().at(0))
); );
} }

19
src/tools/androidtestrunner/main.cpp
View File

@ -264,23 +264,32 @@ static void printHelp()
"\n" "\n"
" Creates an Android package in a temp directory <destination> and\n" " Creates an Android package in a temp directory <destination> and\n"
" runs it on the default emulator/device or on the one specified by\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" " Mandatory arguments:\n"
" --path <path>: The path where androiddeployqt builds the android package.\n" " --path <path>: The path where androiddeployqt builds the android package.\n"
"\n"
" --apk <apk path>: The test apk path. The apk has to exist already, if it\n" " --apk <apk path>: 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" " Optional arguments:\n"
" --make <make cmd>: make command, needed to install the qt library.\n" " --make <make cmd>: make command, needed to install the qt library.\n"
" For Qt 5.14+ this can be \"make apk\".\n" " For Qt 5.14+ this can be \"make apk\".\n"
"\n"
" --adb <adb cmd>: The Android ADB command. If missing the one from\n" " --adb <adb cmd>: The Android ADB command. If missing the one from\n"
" $PATH will be used.\n" " $PATH will be used.\n"
"\n"
" --activity <acitvity>: The Activity to run. If missing the first\n" " --activity <acitvity>: The Activity to run. If missing the first\n"
" activity from AndroidManifest.qml file will be used.\n" " activity from AndroidManifest.qml file will be used.\n"
" --timeout <seconds>: Timeout to run the test.\n" "\n"
" Default is 5 minutes.\n" " --timeout <seconds>: Timeout to run the test. Default is 5 minutes.\n"
"\n"
" --skip-install-root: Do not append INSTALL_ROOT=... to the make command.\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" " --verbose: Prints out information during processing.\n"
"\n"
" --help: Displays this information.\n\n", " --help: Displays this information.\n\n",
qPrintable(QCoreApplication::arguments().at(0)) qPrintable(QCoreApplication::arguments().at(0))
); );