androiddeployqt: make --help documentation-friendly

Change-Id: I08558d23230ec162928fea2c413ae8e2498617d7
Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
This commit is contained in:
Ville Voutilainen 2023-02-06 08:41:41 +02:00
parent edc62595f2
commit 1ebf8c529d

View File

@ -559,112 +559,112 @@ Options parseOptions()
void printHelp() void printHelp()
{ {
fprintf(stderr, "Syntax: %s --output <destination> [options]\n" fprintf(stderr, R"(
"\n" Syntax: androiddeployqt --output <destination> [options]
" Creates an Android package in the build directory <destination> and\n"
" builds it into an .apk file.\n" Creates an Android package in the build directory <destination> and
"\n" builds it into an .apk file.
" Optional arguments:\n"
" --input <inputfile>: Reads <inputfile> for options generated by\n" Optional arguments:
" qmake. A default file name based on the current working\n" --input <inputfile>: Reads <inputfile> for options generated by
" directory will be used if nothing else is specified.\n" qmake. A default file name based on the current working
"\n" directory will be used if nothing else is specified.
" --deployment <mechanism>: Supported deployment mechanisms:\n"
" bundled (default): Includes Qt files in stand-alone package.\n" --deployment <mechanism>: Supported deployment mechanisms:
" unbundled: Assumes native libraries are present on the device\n" bundled (default): Includes Qt files in stand-alone package.
" and does not include them in the APK.\n" unbundled: Assumes native libraries are present on the device
"\n" and does not include them in the APK.
" --aab: Build an Android App Bundle.\n"
"\n" --aab: Build an Android App Bundle.
" --no-build: Do not build the package, it is useful to just install\n"
" a package previously built.\n" --no-build: Do not build the package, it is useful to just install
"\n" a package previously built.
" --install: Installs apk to device/emulator. By default this step is\n"
" not taken. If the application has previously been installed on\n" --install: Installs apk to device/emulator. By default this step is
" the device, it will be uninstalled first.\n" not taken. If the application has previously been installed on
"\n" the device, it will be uninstalled first.
" --reinstall: Installs apk to device/emulator. By default this step\n"
" is not taken. If the application has previously been installed on\n" --reinstall: Installs apk to device/emulator. By default this step
" the device, it will be overwritten, but its data will be left\n" is not taken. If the application has previously been installed on
" intact.\n" the device, it will be overwritten, but its data will be left
"\n" intact.
" --device [device ID]: Use specified device for deployment. Default\n"
" is the device selected by default by adb.\n" --device [device ID]: Use specified device for deployment. Default
"\n" is the device selected by default by adb.
" --android-platform <platform>: Builds against the given android\n"
" platform. By default, the highest available version will be\n" --android-platform <platform>: Builds against the given android
" used.\n" platform. By default, the highest available version will be
"\n" used.
" --release: Builds a package ready for release. By default, the\n"
" package will be signed with a debug key.\n" --release: Builds a package ready for release. By default, the
"\n" package will be signed with a debug key.
" --sign <url/to/keystore> <alias>: Signs the package with the\n"
" specified keystore, alias and store password.\n" --sign <url/to/keystore> <alias>: Signs the package with the
" Optional arguments for use with signing:\n" specified keystore, alias and store password.
" --storepass <password>: Keystore password.\n" Optional arguments for use with signing:
" --storetype <type>: Keystore type.\n" --storepass <password>: Keystore password.
" --keypass <password>: Password for private key (if different\n" --storetype <type>: Keystore type.
" from keystore password.)\n" --keypass <password>: Password for private key (if different
" --sigfile <file>: Name of .SF/.DSA file.\n" from keystore password.)
" --digestalg <name>: Name of digest algorithm. Default is\n" --sigfile <file>: Name of .SF/.DSA file.
" \"SHA1\".\n" --digestalg <name>: Name of digest algorithm. Default is
" --sigalg <name>: Name of signature algorithm. Default is\n" "SHA1".
" \"SHA1withRSA\".\n" --sigalg <name>: Name of signature algorithm. Default is
" --tsa <url>: Location of the Time Stamping Authority.\n" "SHA1withRSA".
" --tsacert <alias>: Public key certificate for TSA.\n" --tsa <url>: Location of the Time Stamping Authority.
" --internalsf: Include the .SF file inside the signature block.\n" --tsacert <alias>: Public key certificate for TSA.
" --sectionsonly: Don't compute hash of entire manifest.\n" --internalsf: Include the .SF file inside the signature block.
" --protected: Keystore has protected authentication path.\n" --sectionsonly: Don't compute hash of entire manifest.
" --jarsigner: Deprecated, ignored.\n" --protected: Keystore has protected authentication path.
"\n" --jarsigner: Deprecated, ignored.
" NOTE: To conceal the keystore information, the environment variables\n"
" QT_ANDROID_KEYSTORE_PATH, and QT_ANDROID_KEYSTORE_ALIAS are used to\n" NOTE: To conceal the keystore information, the environment variables
" set the values keysotore and alias respectively.\n" QT_ANDROID_KEYSTORE_PATH, and QT_ANDROID_KEYSTORE_ALIAS are used to
" Also the environment variables QT_ANDROID_KEYSTORE_STORE_PASS,\n" set the values keysotore and alias respectively.
" and QT_ANDROID_KEYSTORE_KEY_PASS are used to set the store and key\n" Also the environment variables QT_ANDROID_KEYSTORE_STORE_PASS,
" passwords respectively. This option needs only the --sign parameter.\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.
" --jdk <path/to/jdk>: Used to find the jarsigner tool when used\n"
" in combination with the --release argument. By default,\n" --jdk <path/to/jdk>: Used to find the jarsigner tool when used
" an attempt is made to detect the tool using the JAVA_HOME and\n" in combination with the --release argument. By default,
" PATH environment variables, in that order.\n" an attempt is made to detect the tool using the JAVA_HOME and
"\n" PATH environment variables, in that order.
" --qml-import-paths: Specify additional search paths for QML\n"
" imports.\n" --qml-import-paths: Specify additional search paths for QML
"\n" imports.
" --verbose: Prints out information during processing.\n"
"\n" --verbose: Prints out information during processing.
" --no-generated-assets-cache: Do not pregenerate the entry list for\n"
" the assets file engine.\n" --no-generated-assets-cache: Do not pregenerate the entry list for
"\n" the assets file engine.
" --aux-mode: Operate in auxiliary mode. This will only copy the\n"
" dependencies into the build directory and update the XML templates.\n" --aux-mode: Operate in auxiliary mode. This will only copy the
" The project will not be built or installed.\n" dependencies into the build directory and update the XML templates.
"\n" The project will not be built or installed.
" --apk <path/where/to/copy/the/apk>: Path where to copy the built apk.\n"
"\n" --apk <path/where/to/copy/the/apk>: Path where to copy the built apk.
" --qml-importscanner-binary <path/to/qmlimportscanner>: Override the\n"
" default qmlimportscanner binary path. By default the\n" --qml-importscanner-binary <path/to/qmlimportscanner>: Override the
" qmlimportscanner binary is located using the Qt directory\n" default qmlimportscanner binary path. By default the
" specified in the input file.\n" qmlimportscanner binary is located using the Qt directory
"\n" specified in the input file.
" --depfile <path/to/depfile>: Output a dependency file.\n"
"\n" --depfile <path/to/depfile>: Output a dependency file.
" --builddir <path/to/build/directory>: build directory. Necessary when\n"
" generating a depfile because ninja requires relative paths.\n" --builddir <path/to/build/directory>: build directory. Necessary when
"\n" generating a depfile because ninja requires relative paths.
" --no-rcc-bundle-cleanup: skip cleaning rcc bundle directory after\n"
" running androiddeployqt. This option simplifies debugging of\n" --no-rcc-bundle-cleanup: skip cleaning rcc bundle directory after
" the resource bundle content, but it should not be used when deploying\n" running androiddeployqt. This option simplifies debugging of
" a project, since it litters the 'assets' directory.\n" the resource bundle content, but it should not be used when deploying
"\n" a project, since it litters the 'assets' directory.
" --copy-dependencies-only: resolve application dependencies and stop\n"
" deploying process after all libraries and resources that the\n" --copy-dependencies-only: resolve application dependencies and stop
" application depends on have been copied.\n" deploying process after all libraries and resources that the
"\n" application depends on have been copied.
" --help: Displays this information.\n",
qPrintable(QCoreApplication::arguments().at(0)) --help: Displays this information.
); )");
} }
// Since strings compared will all start with the same letters, // Since strings compared will all start with the same letters,