vcpkg/docs/maintainers/vcpkg_build_make.md
nicole mazzuca 6b117c9c7e
[vcpkg docs] Check for documentation generation in CI (#14614)
* [vcpkg docs] Change how documenting port functions works

Instead of using `##`, use comment blocks for documentation.

Also, add some minor docs and change RST -> MD
so we actually get docs generated.

* add CI stuff

* regenerate docs

* fix vcpkg_find_acquire_program to not use _execute_process
2020-12-01 13:37:26 -08:00

1.8 KiB

vcpkg_build_make

Build a linux makefile project.

Usage:

vcpkg_build_make([BUILD_TARGET <target>]
                 [ADD_BIN_TO_PATH]
                 [ENABLE_INSTALL]
                 [MAKEFILE <makefileName>]
                 [LOGFILE_ROOT <logfileroot>])

BUILD_TARGET

The target passed to the make build command (./make <target>). If not specified, the 'all' target will be passed.

ADD_BIN_TO_PATH

Adds the appropriate Release and Debug bin\ directories to the path during the build such that executables can run against the in-tree DLLs.

ENABLE_INSTALL

IF the port supports the install target use vcpkg_install_make() instead of vcpkg_build_make()

MAKEFILE

Specifies the Makefile as a relative path from the root of the sources passed to vcpkg_configure_make()

BUILD_TARGET

The target passed to the make build command (./make <target>). If not specified, the 'all' target will be passed.

DISABLE_PARALLEL

The underlying buildsystem will be instructed to not parallelize

SUBPATH

Additional subdir to invoke make in. Useful if only parts of a port should be built.

Notes:

This command should be preceeded by a call to vcpkg_configure_make(). You can use the alias vcpkg_install_make() function if your CMake script supports the "install" target

Examples

Source

scripts/cmake/vcpkg_build_make.cmake