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 the new ways to report build failures and giving hint messages from portfile.cmake #60

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
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
4 changes: 4 additions & 0 deletions vcpkg/TOC.yml
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,8 @@
href: maintainers/functions/vcpkg_extract_source_archive.md
- name: vcpkg_extract_source_archive_ex
href: maintainers/functions/vcpkg_extract_source_archive_ex.md
- name: vcpkg_fail_with_user_interaction_required
href: maintainers/functions/vcpkg_fail_with_user_interaction_required.md
- name: vcpkg_fail_port_install
href: maintainers/functions/vcpkg_fail_port_install.md
- name: vcpkg_find_acquire_program
Expand Down Expand Up @@ -212,6 +214,8 @@
href: maintainers/functions/vcpkg_replace_string.md
- name: vcpkg_restore_env_variables
href: maintainers/functions/vcpkg_restore_env_variables.md
- name: vcpkg_user_hint_on_failure
href: maintainers/functions/vcpkg_user_hint_on_failure.md
- name: Internal
items:
- name: z_vcpkg_apply_patches
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: vcpkg_fail_with_user_interaction_required
description: Learn how to use vcpkg_fail_with_user_interaction_required.
ms.date: 04/11/2023
---
# vcpkg_fail_with_user_interaction_required

Outputs the message to the console and stops the execution of the `portfile.cmake`.

In comparison to `message(FATAL_ERROR <message>)` vcpkg don't emit instructions on how to report an issue and the `<message>` is printed instead.

## Usage

```cmake
vcpkg_fail_with_user_interaction_required(<message>)
```

## Parameters

### `<message>`

The error message that should be displayed to the user.

## Source

[scripts/cmake/vcpkg\_fail\_with\_user\_interaction\_required.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_fail_with_user_interaction_required.cmake)

27 changes: 27 additions & 0 deletions vcpkg/maintainers/functions/vcpkg_user_hint_on_failure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: vcpkg_user_hint_on_failure
description: Learn how to use vcpkg_user_hint_on_failure.
ms.date: 04/11/2023
---
# vcpkg_user_hint_on_failure

Outputs the message to the console if the building of the port fails.

The message is emitted after the instructions on how to report an issue as an hint how to resolve the build failure.

## Usage

```cmake
vcpkg_user_hint_on_failure(<message>)
```

## Parameters

### `<message>`

The hint message that should be displayed to the user if case of an build failure.

## Source

[scripts/cmake/vcpkg\_user\_hint\_on\_failure.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_user_hint_on_failure.cmake)