diff options
| author | Roger Leigh <rleigh@codelibre.net> | 2018-10-25 20:34:45 +0100 |
|---|---|---|
| committer | Robert Schumacher <roschuma@microsoft.com> | 2018-10-25 12:34:45 -0700 |
| commit | 6d5eba6a6d4f99a03f104e0a639cbbba5325d41b (patch) | |
| tree | c6c8ebcaa56f6c1b487cdd94027b9c1666d058df /docs | |
| parent | 03f4ab3808f90ebc1d3f99b86341d71748eb7364 (diff) | |
| download | vcpkg-6d5eba6a6d4f99a03f104e0a639cbbba5325d41b.tar.gz vcpkg-6d5eba6a6d4f99a03f104e0a639cbbba5325d41b.zip | |
xalan-c: Install headers correctly (#4565)
* Add SKIP_CLEAN option to vcpkg_install_msbuild
Also add vcpkg_clean_msbuild function to factor out clean
logic and allow re-use in portfiles.
* xalan-c: Correct header globbing
* vcpkg_install_msbuild: SKIP_CLEAN documentation correction
* [xalan-c] Add explicit check for localmsgindex header.
[docs] Regenerate
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/maintainers/portfile-functions.md | 3 | ||||
| -rw-r--r-- | docs/maintainers/vcpkg_add_to_path.md | 20 | ||||
| -rw-r--r-- | docs/maintainers/vcpkg_clean_msbuild.md | 15 | ||||
| -rw-r--r-- | docs/maintainers/vcpkg_from_bitbucket.md | 6 | ||||
| -rw-r--r-- | docs/maintainers/vcpkg_from_gitlab.md | 6 | ||||
| -rw-r--r-- | docs/maintainers/vcpkg_install_msbuild.md | 9 | ||||
| -rw-r--r-- | docs/maintainers/vcpkg_test_cmake.md | 20 |
7 files changed, 77 insertions, 2 deletions
diff --git a/docs/maintainers/portfile-functions.md b/docs/maintainers/portfile-functions.md index f9476d3a7..3180609ad 100644 --- a/docs/maintainers/portfile-functions.md +++ b/docs/maintainers/portfile-functions.md @@ -2,10 +2,12 @@ # Portfile helper functions
- [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\_msbuild](vcpkg_build_msbuild.md)
- [vcpkg\_check\_linkage](vcpkg_check_linkage.md)
+- [vcpkg\_clean\_msbuild](vcpkg_clean_msbuild.md)
- [vcpkg\_configure\_cmake](vcpkg_configure_cmake.md)
- [vcpkg\_copy\_pdbs](vcpkg_copy_pdbs.md)
- [vcpkg\_copy\_tool\_dependencies](vcpkg_copy_tool_dependencies.md)
@@ -18,3 +20,4 @@ - [vcpkg\_from\_gitlab](vcpkg_from_gitlab.md)
- [vcpkg\_install\_cmake](vcpkg_install_cmake.md)
- [vcpkg\_install\_msbuild](vcpkg_install_msbuild.md)
+- [vcpkg\_test\_cmake](vcpkg_test_cmake.md)
diff --git a/docs/maintainers/vcpkg_add_to_path.md b/docs/maintainers/vcpkg_add_to_path.md new file mode 100644 index 000000000..3657a5ea7 --- /dev/null +++ b/docs/maintainers/vcpkg_add_to_path.md @@ -0,0 +1,20 @@ +# vcpkg_add_to_path + +Add a directory to the PATH environment variable + +## Usage +```cmake +vcpkg_add_to_path([PREPEND] <${PYTHON3_DIR}>) +``` + +## Parameters +### <positional> +The directory to add + +### PREPEND +Prepends the directory. + +The default is to append. + +## Source +[scripts/cmake/vcpkg_add_to_path.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_add_to_path.cmake)
diff --git a/docs/maintainers/vcpkg_clean_msbuild.md b/docs/maintainers/vcpkg_clean_msbuild.md new file mode 100644 index 000000000..39d07077b --- /dev/null +++ b/docs/maintainers/vcpkg_clean_msbuild.md @@ -0,0 +1,15 @@ +# vcpkg_clean_msbuild + +Clean intermediate files generated by `vcpkg_install_msbuild()`. + +## Usage +```cmake +vcpkg_clean_msbuild() +``` + +## Examples + +* [xalan-c](https://github.com/Microsoft/vcpkg/blob/master/ports/xalan-c/portfile.cmake) + +## Source +[scripts/cmake/vcpkg_clean_msbuild.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_clean_msbuild.cmake)
diff --git a/docs/maintainers/vcpkg_from_bitbucket.md b/docs/maintainers/vcpkg_from_bitbucket.md index c8850b725..7e699f8ea 100644 --- a/docs/maintainers/vcpkg_from_bitbucket.md +++ b/docs/maintainers/vcpkg_from_bitbucket.md @@ -11,6 +11,7 @@ vcpkg_from_bitbucket( [REF <v2.0.0>] [SHA512 <45d0d7f8cc350...>] [HEAD_REF <master>] + [PATCHES <patch1.patch> <patch2.patch>...] ) ``` @@ -40,6 +41,11 @@ The unstable git commit-ish (ideally a branch) to pull for `--head` builds. For most projects, this should be `master`. The chosen branch should be one that is expected to be always buildable on all supported platforms. +### PATCHES +A list of patches to be applied to the extracted sources. + +Relative paths are based on the port directory. + ## Notes: At least one of `REF` and `HEAD_REF` must be specified, however it is preferable for both to be present. diff --git a/docs/maintainers/vcpkg_from_gitlab.md b/docs/maintainers/vcpkg_from_gitlab.md index 69deea933..bc312f37a 100644 --- a/docs/maintainers/vcpkg_from_gitlab.md +++ b/docs/maintainers/vcpkg_from_gitlab.md @@ -11,6 +11,7 @@ vcpkg_from_gitlab( [REF <v10.7.3>] [SHA512 <45d0d7f8cc350...>] [HEAD_REF <master>] + [PATCHES <patch1.patch> <patch2.patch>...] ) ``` @@ -45,6 +46,11 @@ The unstable git commit-ish (ideally a branch) to pull for `--head` builds. For most projects, this should be `master`. The chosen branch should be one that is expected to be always buildable on all supported platforms. +### PATCHES +A list of patches to be applied to the extracted sources. + +Relative paths are based on the port directory. + ## Notes: At least one of `REF` and `HEAD_REF` must be specified, however it is preferable for both to be present. diff --git a/docs/maintainers/vcpkg_install_msbuild.md b/docs/maintainers/vcpkg_install_msbuild.md index 76578c2ef..1de68ce70 100644 --- a/docs/maintainers/vcpkg_install_msbuild.md +++ b/docs/maintainers/vcpkg_install_msbuild.md @@ -52,12 +52,16 @@ Indicates that top-level include files (e.g. `include/zlib.h`) should be allowed ### REMOVE_ROOT_INCLUDES Indicates that top-level include files (e.g. `include/Makefile.am`) should be removed. +### SKIP_CLEAN +Indicates that the intermediate files should not be removed. + +Ports using this option should later call [`vcpkg_clean_msbuild()`](vcpkg_clean_msbuild.md) to manually clean up. + ### RELEASE_CONFIGURATION The configuration (``/p:Configuration`` msbuild parameter) used for Release builds. ### DEBUG_CONFIGURATION -The configuration (``/p:Configuration`` msbuild parameter) -used for Debug builds. +The configuration (``/p:Configuration`` msbuild parameter) used for Debug builds. ### TARGET_PLATFORM_VERSION The WindowsTargetPlatformVersion (``/p:WindowsTargetPlatformVersion`` msbuild parameter) @@ -82,6 +86,7 @@ Additional options passed to msbuild for Debug builds. These are in addition to ## Examples +* [xalan-c](https://github.com/Microsoft/vcpkg/blob/master/ports/xalan-c/portfile.cmake) * [libimobiledevice](https://github.com/Microsoft/vcpkg/blob/master/ports/libimobiledevice/portfile.cmake) ## Source diff --git a/docs/maintainers/vcpkg_test_cmake.md b/docs/maintainers/vcpkg_test_cmake.md new file mode 100644 index 000000000..15b3ad797 --- /dev/null +++ b/docs/maintainers/vcpkg_test_cmake.md @@ -0,0 +1,20 @@ +# vcpkg_test_cmake + +Tests a built package for CMake `find_package()` integration. + +## Usage: +```cmake +vcpkg_test_cmake(PACKAGE_NAME <name> [MODULE]) +``` + +## Parameters: + +### PACKAGE_NAME +The expected name to find with `find_package()`. + +### MODULE +Indicates that the library expects to be found via built-in CMake targets. + + +## Source +[scripts/cmake/vcpkg_test_cmake.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_test_cmake.cmake)
|
