diff options
| author | Martin Vejdarski <extrulm@gmail.com> | 2020-05-12 04:58:12 +0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-05-11 14:58:12 -0700 |
| commit | 6d5a1a897eca21b956d7b1de71af9a1f25c08e33 (patch) | |
| tree | 1e0a84af5b291e56e0d50c85567833581ecba609 /docs | |
| parent | 06c647e11a21dd4c193e63968e1d3f9024e05996 (diff) | |
| download | vcpkg-6d5a1a897eca21b956d7b1de71af9a1f25c08e33.tar.gz vcpkg-6d5a1a897eca21b956d7b1de71af9a1f25c08e33.zip | |
[gn, crashpad] Add GN build support and crashpad port (#10505)
* [vcpkg_find_acquire_program] Add gn
* [GN] Add build system support
* [crashpad] Add new port
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/maintainers/portfile-functions.md | 10 | ||||
| -rw-r--r-- | docs/maintainers/vcpkg_build_gn.md | 17 | ||||
| -rw-r--r-- | docs/maintainers/vcpkg_build_ninja.md | 17 | ||||
| -rw-r--r-- | docs/maintainers/vcpkg_configure_gn.md | 30 | ||||
| -rw-r--r-- | docs/maintainers/vcpkg_find_acquire_program.md | 1 | ||||
| -rw-r--r-- | docs/maintainers/vcpkg_install_gn.md | 23 |
6 files changed, 95 insertions, 3 deletions
diff --git a/docs/maintainers/portfile-functions.md b/docs/maintainers/portfile-functions.md index 4cd42a685..591516466 100644 --- a/docs/maintainers/portfile-functions.md +++ b/docs/maintainers/portfile-functions.md @@ -1,13 +1,15 @@ -<!-- Run regenerate.ps1 to extract documentation from scripts\cmake\*.cmake --> - +<!-- Run regenerate.ps1 to extract documentation from scripts\cmake\*.cmake -->
+
# Portfile helper functions
- [execute\_process](execute_process.md)
- [vcpkg\_acquire\_msys](vcpkg_acquire_msys.md)
- [vcpkg\_add\_to\_path](vcpkg_add_to_path.md)
- [vcpkg\_apply\_patches](vcpkg_apply_patches.md)
- [vcpkg\_build\_cmake](vcpkg_build_cmake.md)
+- [vcpkg\_build\_gn](vcpkg_build_gn.md)
- [vcpkg\_build\_make](vcpkg_build_make.md)
- [vcpkg\_build\_msbuild](vcpkg_build_msbuild.md)
+- [vcpkg\_build\_ninja](vcpkg_build_ninja.md)
- [vcpkg\_build\_nmake](vcpkg_build_nmake.md)
- [vcpkg\_check\_features](vcpkg_check_features.md)
- [vcpkg\_check\_linkage](vcpkg_check_linkage.md)
@@ -15,11 +17,12 @@ - [vcpkg\_clean\_msbuild](vcpkg_clean_msbuild.md)
- [vcpkg\_common\_definitions](vcpkg_common_definitions.md)
- [vcpkg\_configure\_cmake](vcpkg_configure_cmake.md)
+- [vcpkg\_configure\_gn](vcpkg_configure_gn.md)
- [vcpkg\_configure\_make](vcpkg_configure_make.md)
- [vcpkg\_configure\_meson](vcpkg_configure_meson.md)
- [vcpkg\_copy\_pdbs](vcpkg_copy_pdbs.md)
-- [vcpkg\_copy\_tools](vcpkg_copy_tools.md)
- [vcpkg\_copy\_tool\_dependencies](vcpkg_copy_tool_dependencies.md)
+- [vcpkg\_copy\_tools](vcpkg_copy_tools.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)
@@ -33,6 +36,7 @@ - [vcpkg\_from\_github](vcpkg_from_github.md)
- [vcpkg\_from\_gitlab](vcpkg_from_gitlab.md)
- [vcpkg\_install\_cmake](vcpkg_install_cmake.md)
+- [vcpkg\_install\_gn](vcpkg_install_gn.md)
- [vcpkg\_install\_make](vcpkg_install_make.md)
- [vcpkg\_install\_meson](vcpkg_install_meson.md)
- [vcpkg\_install\_msbuild](vcpkg_install_msbuild.md)
diff --git a/docs/maintainers/vcpkg_build_gn.md b/docs/maintainers/vcpkg_build_gn.md new file mode 100644 index 000000000..3c3407d92 --- /dev/null +++ b/docs/maintainers/vcpkg_build_gn.md @@ -0,0 +1,17 @@ +# vcpkg_build_gn + +Build a GN project + +## Usage: +```cmake +vcpkg_build_gn( + [TARGETS <target>...] +) +``` + +## Parameters: +### TARGETS +Only build the specified targets. + +## Source +[scripts/cmake/vcpkg_build_gn.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_build_gn.cmake)
diff --git a/docs/maintainers/vcpkg_build_ninja.md b/docs/maintainers/vcpkg_build_ninja.md new file mode 100644 index 000000000..56a1b6050 --- /dev/null +++ b/docs/maintainers/vcpkg_build_ninja.md @@ -0,0 +1,17 @@ +# vcpkg_build_ninja + +Build a ninja project + +## Usage: +```cmake +vcpkg_build_ninja( + [TARGETS <target>...] +) +``` + +## Parameters: +### TARGETS +Only build the specified targets. + +## Source +[scripts/cmake/vcpkg_build_ninja.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_build_ninja.cmake)
diff --git a/docs/maintainers/vcpkg_configure_gn.md b/docs/maintainers/vcpkg_configure_gn.md new file mode 100644 index 000000000..7d98ac9a9 --- /dev/null +++ b/docs/maintainers/vcpkg_configure_gn.md @@ -0,0 +1,30 @@ +# vcpkg_configure_gn + +Generate Ninja (GN) targets + +## Usage: +```cmake +vcpkg_configure_gn( + SOURCE_PATH <SOURCE_PATH> + [OPTIONS <OPTIONS>] + [OPTIONS_DEBUG <OPTIONS_DEBUG>] + [OPTIONS_RELEASE <OPTIONS_RELEASE>] +) +``` + +## Parameters: +### SOURCE_PATH (required) +The path to the GN project. + +### OPTIONS +Options to be passed to both the debug and release targets. +Note: Must be provided as a space-separated string. + +### OPTIONS_DEBUG (space-separated string) +Options to be passed to the debug target. + +### OPTIONS_RELEASE (space-separated string) +Options to be passed to the release target. + +## Source +[scripts/cmake/vcpkg_configure_gn.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_configure_gn.cmake)
diff --git a/docs/maintainers/vcpkg_find_acquire_program.md b/docs/maintainers/vcpkg_find_acquire_program.md index 83e01ce00..461d13822 100644 --- a/docs/maintainers/vcpkg_find_acquire_program.md +++ b/docs/maintainers/vcpkg_find_acquire_program.md @@ -25,6 +25,7 @@ The current list of programs includes: - PYTHON2 - PYTHON3 - GIT +- GN - GO - JOM - MESON diff --git a/docs/maintainers/vcpkg_install_gn.md b/docs/maintainers/vcpkg_install_gn.md new file mode 100644 index 000000000..a1d4156c7 --- /dev/null +++ b/docs/maintainers/vcpkg_install_gn.md @@ -0,0 +1,23 @@ +# vcpkg_install_gn + +Installs a GN project + +## Usage: +```cmake +vcpkg_install_gn( + SOURCE_PATH <SOURCE_PATH> + [TARGETS <target>...] +) +``` + +## Parameters: +### SOURCE_PATH +The path to the source directory + +### TARGETS +Only install the specified targets. + +Note: includes must be handled separately + +## Source +[scripts/cmake/vcpkg_install_gn.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_install_gn.cmake)
|
