[docs] Add docs for remove command (#25264)

* [docs] Add docs for remove command

* [docs] CR
This commit is contained in:
Robert Schumacher 2022-06-24 13:11:32 -07:00 committed by GitHub
parent 763f6664c1
commit 6bd8d772ee
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 48 additions and 0 deletions

View file

@ -7,6 +7,9 @@
- [Common Options](common-options.md)
- Commands
- [vcpkg install](install.md)
- [vcpkg integrate](integrate.md)
- [vcpkg remove](remove.md)
- [vcpkg search](search.md)
## Source

View file

@ -22,6 +22,8 @@ Build and install port packages.
In Classic Mode, this verb adds port packages to the existing set in the [installed directory][] (defaults to `installed/` under the vcpkg root). This can require removing and rebuilding existing packages, which can fail.
<a id="package-syntax"></a>
**Package Syntax**
```
portname[feature1,feature2]:triplet

43
docs/commands/remove.md Normal file
View file

@ -0,0 +1,43 @@
# vcpkg remove
**The latest version of this documentation is available on [GitHub](https://github.com/Microsoft/vcpkg/tree/master/docs/commands/remove.md).**
## Synopsis
```no-highlight
vcpkg remove [options] <package>...
```
```no-highlight
vcpkg remove --outdated [options]
```
## Description
Remove port packages from Classic Mode.
`remove` removes listed packages and any packages that require them from the Classic Mode [installed directory][common-options.md#install-root]. See the [install command documentation](install.md#package-syntax) for detailed syntax of the `<package>` parameter.
This command is not currently supported in [Manifest Mode][].
## Options
All vcpkg commands support a set of [common options](common-options.md).
### `--recurse`
Allow removing packages not specified on the command line.
By default, vcpkg refuses to execute a removal plan that would remove packages not listed on the command line.
### `--dry-run`
Print the packages to be removed, but do not remove them.
### `--outdated`
Remove all packages that do not match the available port versions.
For each installed package, vcpkg will compare the installed version string to the version string of the current recipe. If those versions differ, the package will be selected for removal. If `--outdated` is passed, no packages should be listed on the command line.
[Manifest Mode]: ../users/manifests.md