aboutsummaryrefslogtreecommitdiffstats
path: root/scripts/vstools/usage.cmd
blob: 423a24d58d6e6ad68ff47354d0fe05ed80f5129c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
::**************************************************************************************************
::Copyright (C) 2024 The Qt Company Ltd.
::SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
::**************************************************************************************************

::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
::usage.cmd
:: * Print tool usage instructions
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
ECHO.
%##########################%
%##%
%##% Usage:
%##%
%##%     %SCRIPT% [VS Versions] [Operation] [Options] [ -- ^<MSBuild Options^> ]
%##%
%##########################%
%##%
%##% == 'VS Versions' can be one or more of the following:
%##%  -vs2022 ................ Select the latest version of Visual Studio 2022
%##%  -vs2019 ................ Select the latest version of Visual Studio 2019
%##%  -version ^<X^>.^<Y^> ....... Select version X.Y of Visual Studio
%##%                           Can be specified several times
%##%
%##%  If no version is specified, the most recent version of VS is selected.
%##%
%##% == 'Operation' can be one of the following:
%##%  -build .... Incremental build of solution
%##%  -rebuild .. Clean build of solution
%##%  -init ..... Initialize vstools solution for the specified version of VS
%##%              If multiple versions are specified, the last one is selected
%##%  -startvs .. Open vstools solution in selected VS version
%##%  -list ..... Print list of Visual Studio installations
%##%  -help ..... Print tool usage instructions
%##%
%##%  If no operation is specified, -build is assumed by default.
%##%
%##% == 'Options' can be one or more of the following
%##%  -vcvars ^<ARCH^> ......... Select ARCH as the argument to the vcvars script
%##%                           Can be one of:  x86, x64, arm64, amd64, x86_amd64
%##%                           x86_x64, x86_arm, x86_arm64, amd64_x86, x64_x86,
%##%                           amd64_arm, x64_arm, amd64_arm64, x64_arm64,
%##%                           arm64_amd64, arm64_x64, arm64_x86, arm64_arm
%##%  -config ^<NAME^> ......... Select NAME as the build configuration
%##%                           Defaults to the 'Release' configuration
%##%                           Only valid with -build or -rebuild
%##%  -platform ^<NAME^> ....... Select NAME as the build platform
%##%                           Only valid with -build or -rebuild
%##%  -test .................. Run auto-tests after successful build
%##%                           Only valid with -build or -rebuild
%##%  -deploy ^<DEPLOY_DIR^> ... Deploy installation package to DEPLOY_DIR
%##%                           Only valid with -build or -rebuild
%##%  -install ............... Install extension to selected VS version(s)
%##%                           Pops up VSIX installer dialog for confirmation
%##%  -startvs ............... Open vstools solution in selected VS version
%##%                           If multiple versions are specified, the last one
%##%                           is selected
%##%  -all ................... Include all VS installations
%##%                           By default, the latest installation is selected
%##%  -verbose ............... Print more detailed log information
%##%  -bl .................... Generate MSBuild binary log
%##%                           Only valid with -build or -rebuild
%##%
%##% == All arguments after '--' are passed verbatim to MSBuild
%##%  Example:
%##%      vstools -version 17.4 -rebuild -- -p:WarningLevel=3
%##%
%##########################%