Skip to content

Commit 5bcbec1

Browse files
authored
Merge pull request #1983 from TerryGLee/tglee-vsinstall
update Installation Options screenshot and add caveat to new command-line option
2 parents 9c4cef7 + ef4c182 commit 5bcbec1

File tree

3 files changed

+24
-24
lines changed

3 files changed

+24
-24
lines changed
Loading

docs/install/update-visual-studio.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ When there is an update, there's a corresponding notification flag in Visual Stu
4949
Your update continues. Then, when it's complete, Visual Studio restarts.
5050

5151
> [!NOTE]
52-
> If you run Visual Studio in administrator mode, you must manually restart Visual Studio after the update.
52+
> When you run Visual Studio in administrator mode, you must manually restart Visual Studio after the update.
5353
5454
### Use the IDE
5555

@@ -66,7 +66,7 @@ You can check for an update and then install the update from the menu bar in Vis
6666
The update proceeds as described in the previous section, and then Visual Studio restarts after the update completes successfully.
6767

6868
> [!NOTE]
69-
> If you run Visual Studio in administrator mode, you must manually restart Visual Studio after the update.
69+
> When you run Visual Studio in administrator mode, you must manually restart Visual Studio after the update.
7070
7171
### Use the Visual Studio Installer
7272

docs/install/use-command-line-parameters-to-install-visual-studio.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ The command-line options are used in conjunction with the setup bootstrapper, wh
5555
| `--installPath <dir>` | The installation directory for the instance to act upon. For the install command, this is **Optional** and is where the instance will be installed. For other commands, this is **Required** and is where the previously installed instance was installed. |
5656
| `--addProductLang <language-locale>` | **Optional**: During an install or modify operation, this determines the UI language packs that are installed to the product. It can appear multiple times on the command line to add multiple language packs. If not present, the installation uses the machine locale. For more information, see the [List of language locales](#list-of-language-locales) section on this page.|
5757
| `--removeProductLang <language-locale>` | **Optional**: During an install or modify operation, this determines the UI language packs that are to be removed from the product. It can appear multiple times on the command line to add multiple language packs. For more information, see the [List of language locales](#list-of-language-locales) section on this page.|
58-
| `--add <one or more workload or component IDs>` | **Optional**: One or more workload or component IDs to add. The required components of the artifact are installed, but not the recommended or optional components. You can control additional components globally using `--includeRecommended` and/or `--includeOptional`. For finer-grained control, you can append `;includeRecommended` or `;includeOptional` to the ID (for example, `--add Workload1;includeRecommended` or `--add Workload2;includeRecommended;includeOptional`). For more information, see our [Workload and component IDs](workload-and-component-ids.md) page. You can repeat this option as necessary.|
58+
| `--add <one or more workload or component IDs>` | **Optional**: One or more workload or component IDs to add. The required components of the artifact are installed, but not the recommended or optional components. You can control additional components globally using `--includeRecommended` and/or `--includeOptional`. For finer-grained control, you can append `;includeRecommended` or `;includeOptional` to the ID (for example, `--add Workload1;includeRecommended` or `--add Workload2;includeRecommended;includeOptional`). For more information, see the [Workload and component IDs](workload-and-component-ids.md) page. You can repeat this option as necessary.|
5959
| `--remove <one or more workload or component IDs>` | **Optional**: One or more workload or component IDs to remove. For more information, see our [Workload and component IDs](workload-and-component-ids.md) page. You can repeat this option as necessary.|
6060
| `--in <path>` | **Optional**: The URI or path to a response file. |
6161
| `--all` | **Optional**: Whether to install all workloads and components for a product. |
@@ -64,7 +64,7 @@ The command-line options are used in conjunction with the setup bootstrapper, wh
6464
| `--includeOptional` | **Optional**: Includes the optional components for any workloads that are installed, but not the recommended components. The workloads are specified either with `--allWorkloads` or `--add`. |
6565
| `--quiet, -q` | **Optional**: Do not display any user interface while performing the installation. |
6666
| `--passive, -p` | **Optional**: Display the user interface, but do not request any interaction from the user. |
67-
| `--norestart` | **Optional**: If present, commands with `--passive` or `--quiet` will not automatically restart the machine (if required). This is ignored if neither `--passive` nor `--quiet` are specified. |
67+
| `--norestart` | **Optional**: If present, commands with `--passive` or `--quiet` will not automatically restart the machine (if necessary). This is ignored if neither `--passive` nor `--quiet` are specified. |
6868
| `--nickname <name>` | **Optional**: This defines the nickname to assign to an installed product. The nickname cannot be longer than 10 characters. |
6969
| `--productKey` | **Optional**: This defines the product key to use for an installed product. It is composed of 25 alphanumeric characters either in the format `xxxxx-xxxxx-xxxxx-xxxxx-xxxxx` or `xxxxxxxxxxxxxxxxxxxxxxxxx`. |
7070
| `--help, --?, -h, -?` | Display an offline version of this page. |
@@ -75,12 +75,12 @@ The command-line options are used in conjunction with the setup bootstrapper, wh
7575
| ----------------------- | --------------- |
7676
| `--layout <dir>` | Specifies a directory to create an offline install cache. For more information, see [Create a network-based installation of Visual Studio](create-a-network-installation-of-visual-studio.md).|
7777
| `--lang <one or more language-locales>` | **Optional**: Used with `--layout` to prepare an offline install cache with resource packages with the specified language(s). For more information, see the [List of language locales](#list-of-language-locales) section on this page.|
78-
| `--add <one or more workload or component IDs>` | **Optional**: One or more workload or component IDs to add. The required components of the artifact are installed, but not the recommended or optional components. You can control additional components globally using `--includeRecommended` and/or `--includeOptional`. For finer-grained control, you can append `;includeRecommended` or `;includeOptional` to the ID (for example, `--add Workload1;includeRecommended` or `--add Workload2;includeOptional`). For more information, see our [Workload and component IDs](workload-and-component-ids.md) page. <br/>**Note**: If `--add` is used, only the specified workloads and components and their dependencies are downloaded. If `--add` is not specified, all workloads and components are downloaded to the layout.|
78+
| `--add <one or more workload or component IDs>` | **Optional**: One or more workload or component IDs to add. The required components of the artifact are installed, but not the recommended or optional components. You can control additional components globally using `--includeRecommended` and/or `--includeOptional`. For finer-grained control, you can append `;includeRecommended` or `;includeOptional` to the ID (for example, `--add Workload1;includeRecommended` or `--add Workload2;includeOptional`). For more information, see the [Workload and component IDs](workload-and-component-ids.md) page. <br/>**Note**: If `--add` is used, only the specified workloads and components and their dependencies are downloaded. If `--add` is not specified, all workloads and components are downloaded to the layout.|
7979
| `--includeRecommended` | **Optional**: Includes the recommended components for any workloads that are installed, but not the optional components. The workloads are specified either with `--allWorkloads` or `--add`. |
8080
| `--includeOptional` | **Optional**: Includes the recommended *and* optional components for any workloads being included in the layout. The workloads are specified with `--add`. |
8181
| `--keepLayoutVersion` | **New in 15.3, optional**: Apply changes to the layout without updating the version of the layout. |
82-
| `--verify` | **New in 15.3, optional**: Verify the contents of a layout. Any corrupt or missing files are listed. |
83-
| `--fix` | **New in 15.3, optional**: Verify the contents of a layout. If any files are found to be corrupt or missing, they are re-downloaded. Internet access is required to fix a layout. |
82+
| `--verify` | **New in 15.3, optional**: Verify the contents of a layout. Any corrupt or missing files are listed. |
83+
| `--fix` | **New in 15.3, optional**: Verify the contents of a layout. If any files are found to be corrupt or missing, they are redownloaded. Internet access is required to fix a layout. |
8484
| `--clean <one or more paths to catalogs>` | **New in 15.3, optional**: Removes old versions of components from a layout that has been updated to a newer version. |
8585

8686
| **Advanced install options** | **Description** |
@@ -97,8 +97,8 @@ The command-line options are used in conjunction with the setup bootstrapper, wh
9797
| `--noUpdateInstaller` | **New in 15.2, optional**: If present, prevents the installer from updating itself when quiet is specified. The installer will fail the command and return a non-zero exit code if noUpdateInstaller is specified with quiet when an installer update is required. |
9898
| `--noWeb` | **New in 15.3, optional**: Setup now downloads any content that it is installing from the Internet. All content that is being installed must be available in an offline layout. If the layout is missing content, setup fails. For more information, see [Deploying from a network installation](create-a-network-installation-of-visual-studio.md). |
9999
| `--path <name>=<path>` | **New in 15.7, optional**: Used to specify custom install paths for the installation. Supported path names are shared, cache, and install. |
100-
| `--path cache=<path>` | **New in 15.7, optional**: Uses the location you specify to download installation files. This location can only be set the first time Visual Studio is installed. Example: `--path cache="C:\VS\cache"` |
101-
| `--path shared=<path>` | **New in 15.7, optional**: Contains shared files for side-by-side Visual Studio installations. Some tools and SDKs install to a location on this drive, while some others might override this setting and install to another drive. Example: `--path shared="C:\VS\shared"` |
100+
| `--path cache=<path>` | **New in 15.7, optional**: Uses the location you specify to download installation files. This location can only be set the first time that Visual Studio is installed. Example: `--path cache="C:\VS\cache"` |
101+
| `--path shared=<path>` | **New in 15.7, optional**: Contains shared files for side-by-side Visual Studio installations. Some tools and SDKs install to a location on this drive, while some others might override this setting and install to another drive. Example: `--path shared="C:\VS\shared"` <br><br>Important: This can be set only once and on the first time that Visual Studio is installed. |
102102
| `--path install=<path>` | **New in 15.7, optional**: Equivalent to `–-installPath`. Specifically, `--installPath "C:\VS"` and `--path install="C:\VS"` are equivalent. Only one of these can be used at a time. |
103103

104104
## List of workload IDs and component IDs
@@ -109,24 +109,24 @@ For a list of workload and component IDs sorted by Visual Studio product, see th
109109

110110
| **Language-locale** | **Language** |
111111
| ----------------------- | --------------- |
112-
| cs-CZ | Czech |
113-
| de-DE | German |
114-
| en-US | English |
115-
| es-ES | Spanish |
116-
| fr-FR | French |
117-
| it-IT | Italian |
118-
| ja-JP | Japanese |
119-
| ko-KR | Korean |
120-
| pl-PL | Polish |
121-
| pt-BR | Portuguese - Brazil |
122-
| ru-RU | Russian |
123-
| tr-TR | Turkish |
124-
| zh-CN | Chinese - Simplified |
125-
| zh-TW | Chinese - Traditional |
112+
| Cs-cz | Czech |
113+
| De-de | German |
114+
| En-us | English |
115+
| Es-es | Spanish |
116+
| Fr-fr | French |
117+
| It-it | Italian |
118+
| Ja-jp | Japanese |
119+
| Ko-kr | Korean |
120+
| Pl-pl | Polish |
121+
| Pt-br | Portuguese - Brazil |
122+
| Ru-ru | Russian |
123+
| Tr-tr | Turkish |
124+
| Zh-cn | Chinese - Simplified |
125+
| Zh-tw | Chinese - Traditional |
126126

127127
## Error codes
128128

129-
Depending on the result of the operation, the `%ERRORLEVEL%` environment variable will be set to one of the following values:
129+
Depending on the result of the operation, the `%ERRORLEVEL%` environment variable is set to one of the following values:
130130

131131
| **Value** | **Result** |
132132
| --------- | ---------- |

0 commit comments

Comments
 (0)