mirror of
https://github.com/cemu-project/vcpkg.git
synced 2025-02-22 18:47:09 +01:00
[docs]Update cmake docs (#7039)
This commit is contained in:
parent
ab81312c63
commit
1ce24dd0db
@ -12,6 +12,7 @@
|
||||
- [vcpkg\_copy\_pdbs](vcpkg_copy_pdbs.md)
|
||||
- [vcpkg\_copy\_tool\_dependencies](vcpkg_copy_tool_dependencies.md)
|
||||
- [vcpkg\_download\_distfile](vcpkg_download_distfile.md)
|
||||
- [vcpkg\_execute\_build\_process](vcpkg_execute_build_process.md)
|
||||
- [vcpkg\_execute\_required\_process](vcpkg_execute_required_process.md)
|
||||
- [vcpkg\_extract\_source\_archive](vcpkg_extract_source_archive.md)
|
||||
- [vcpkg\_extract\_source\_archive\_ex](vcpkg_extract_source_archive_ex.md)
|
||||
|
@ -7,6 +7,7 @@ Configure CMake for Debug and Release builds of a project.
|
||||
vcpkg_configure_cmake(
|
||||
SOURCE_PATH <${SOURCE_PATH}>
|
||||
[PREFER_NINJA]
|
||||
[DISABLE_PARALLEL_CONFIGURE]
|
||||
[GENERATOR <"NMake Makefiles">]
|
||||
[OPTIONS <-DUSE_THIS_IN_ALL_BUILDS=1>...]
|
||||
[OPTIONS_RELEASE <-DOPTIMIZE=1>...]
|
||||
|
36
docs/maintainers/vcpkg_execute_build_process.md
Normal file
36
docs/maintainers/vcpkg_execute_build_process.md
Normal file
@ -0,0 +1,36 @@
|
||||
# vcpkg_execute_build_process
|
||||
|
||||
Execute a required build process
|
||||
|
||||
## Usage
|
||||
```cmake
|
||||
vcpkg_execute_build_process(
|
||||
COMMAND <cmd> [<args>...]
|
||||
[NO_PARALLEL_COMMAND <cmd> [<args>...]]
|
||||
WORKING_DIRECTORY </path/to/dir>
|
||||
LOGNAME <log_name>)
|
||||
)
|
||||
```
|
||||
## Parameters
|
||||
### COMMAND
|
||||
The command to be executed, along with its arguments.
|
||||
|
||||
### NO_PARALLEL_COMMAND
|
||||
Optional parameter which specifies a non-parallel command to attempt if a
|
||||
failure potentially due to parallelism is detected.
|
||||
|
||||
### WORKING_DIRECTORY
|
||||
The directory to execute the command in.
|
||||
|
||||
### LOGNAME
|
||||
The prefix to use for the log files.
|
||||
|
||||
This should be a unique name for different triplets so that the logs don't
|
||||
conflict when building multiple at once.
|
||||
|
||||
## Examples
|
||||
|
||||
* [icu](https://github.com/Microsoft/vcpkg/blob/master/ports/icu/portfile.cmake)
|
||||
|
||||
## Source
|
||||
[scripts/cmake/vcpkg_execute_build_process.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_execute_build_process.cmake)
|
@ -25,7 +25,7 @@ The full path to the archive to be extracted.
|
||||
This is usually obtained from calling [`vcpkg_download_distfile`](vcpkg_download_distfile.md).
|
||||
|
||||
### REF
|
||||
A friendly name that will be used instead of the filename of the archive.
|
||||
A friendly name that will be used instead of the filename of the archive. If more than 10 characters it will be truncated.
|
||||
|
||||
By convention, this is set to the version number or tag fetched
|
||||
|
||||
|
@ -24,6 +24,7 @@ The current list of programs includes:
|
||||
- MESON
|
||||
- NASM
|
||||
- NINJA
|
||||
- NUGET
|
||||
- YASM
|
||||
- ARIA2 (Downloader)
|
||||
|
||||
|
@ -7,6 +7,7 @@
|
||||
## vcpkg_configure_cmake(
|
||||
## SOURCE_PATH <${SOURCE_PATH}>
|
||||
## [PREFER_NINJA]
|
||||
## [DISABLE_PARALLEL_CONFIGURE]
|
||||
## [GENERATOR <"NMake Makefiles">]
|
||||
## [OPTIONS <-DUSE_THIS_IN_ALL_BUILDS=1>...]
|
||||
## [OPTIONS_RELEASE <-DOPTIMIZE=1>...]
|
||||
|
@ -25,7 +25,7 @@
|
||||
## This is usually obtained from calling [`vcpkg_download_distfile`](vcpkg_download_distfile.md).
|
||||
##
|
||||
## ### REF
|
||||
## A friendly name that will be used instead of the filename of the archive.
|
||||
## A friendly name that will be used instead of the filename of the archive. If more than 10 characters it will be truncated.
|
||||
##
|
||||
## By convention, this is set to the version number or tag fetched
|
||||
##
|
||||
|
Loading…
x
Reference in New Issue
Block a user