Skip to content

Commit

Permalink
vcpkg_replace_string: update docs (#367)
Browse files Browse the repository at this point in the history
  • Loading branch information
autoantwort authored Jul 22, 2024
1 parent de71e0b commit 50953fd
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion vcpkg/maintainers/functions/vcpkg_replace_string.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,13 @@ Replace a string in a file.
## Usage

```cmake
vcpkg_replace_string(<filename> <match> <replace>)
vcpkg_replace_string(<filename> <match> <replace> [REGEX] [IGNORE_UNCHANGED])
```

## Parameters

### `<filename>`

The path to the file to modify.

### `<match>`
Expand All @@ -26,6 +27,14 @@ The string to match.

The string to replace all matched sequences with.

### `[REGEX]`

If this argument is present, the `<match>` argument is treated as a regular expression.

### `[IGNORE_UNCHANGED]`

Disable the warning if the file is not changed.

## Source

[scripts/cmake/vcpkg\_replace\_string.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_replace_string.cmake)

0 comments on commit 50953fd

Please sign in to comment.