Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for 'test-features' #131

Closed
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions vcpkg/TOC.yml
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,8 @@
href: commands/remove.md
- name: vcpkg search
href: commands/search.md
- name: vcpkg test-features
href: commands/test-features.md
- name: vcpkg update
href: commands/update.md
- name: vcpkg x-update-baseline
Expand Down
68 changes: 68 additions & 0 deletions vcpkg/commands/test-features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
title: vcpkg test-features
description: Command line reference for the vcpkg test-features command. Builds all features of a package.
ms.date: 08/15/2023
---

# vcpkg test-features

## Synopsis

```console
vcpkg test-features [options] <package>...
```

## Description

Tests all features of a package by installing them in manifest mode. This command is useful for testing that all features of a package are working correctly.
The following tests are performed:
- The core feature gets installed with default featured disabled
- Every feature gets installed with default featured disabled
- All features combined gets installed
autoantwort marked this conversation as resolved.
Show resolved Hide resolved

## Example

```console
$ vcpkg test-features gdal
Compute 34 install plans ...
Compute all abis ...
Detecting compiler hash for triplet arm64-osx...
Check the binary cache

1/34 gdal[core]:arm64-osx
...
```

## Options

All vcpkg commands support a set of [common options](common-options.md).

### `--ci-feature-baseline`

Path to the ci.feature.baseline.txt file. Used to skip ports and detect regressions.

You can find a documentation of the file [here](https://github.com/autoantwort/vcpkg/blob/ce6c48c28ced5a9d0cfe54614049637b6721cf7c/scripts/ci.feature.baseline.txt).

### `--all`

Test the features of all packages.

### `--dont-test-feature-core`

Skip testing the core feature.

### `--dont-test-features-separately`

Skip testing each feature separately.

### `--dont-test-features-combined`

Skip testing all features combined.

### `--failure-logs`

Directory to which failure logs will be copied.

### `--write-failure-abis-to`

Path to a file to which abis from ports that failed to build will be written.