vcpkg/docs/maintainers/vcpkg_from_sourceforge.md
Jack·Boos·Yu 2b20b27b0d
[docs] Fix the automatically generated document URL (#16611)
* [document] Fix the automatically generated document URL

* [docs] Format all documents
2021-03-10 11:56:07 -06:00

2.5 KiB

vcpkg_from_sourceforge

The latest version of this document lives in the vcpkg repo.

Download and extract a project from sourceforge.

Usage:

vcpkg_from_sourceforge(
    OUT_SOURCE_PATH SOURCE_PATH
    REPO <cunit/CUnit>
    [REF <2.1-3>]
    SHA512 <547b417109332...>
    FILENAME <CUnit-2.1-3.tar.bz2>
    [DISABLE_SSL]
    [NO_REMOVE_ONE_LEVEL]
    [PATCHES <patch1.patch> <patch2.patch>...]
)

Parameters:

OUT_SOURCE_PATH

Specifies the out-variable that will contain the extracted location.

This should be set to SOURCE_PATH by convention.

REPO

The organization or user and repository (optional) on sourceforge.

REF

A stable version number that will not change contents.

FILENAME

The local name for the file. Files are shared between ports, so the file may need to be renamed to make it clearly attributed to this port and avoid conflicts.

For example, we can get the download link: https://sourceforge.net/settings/mirror_choices?projectname=mad&filename=libmad/0.15.1b/libmad-0.15.1b.tar.gz&selected=nchc So the REPO is mad/libmad, the REF is 0.15.1b, and the FILENAME is libmad-0.15.1b.tar.gz

For some special links: https://sourceforge.net/settings/mirror_choices?projectname=soxr&filename=soxr-0.1.3-Source.tar.xz&selected=nchc The REPO is soxr, REF is not exist, and the FILENAME is soxr-0.1.3-Source.tar.xz

SHA512

The SHA512 hash that should match the archive.

WORKING_DIRECTORY

If specified, the archive will be extracted into the working directory instead of ${CURRENT_BUILDTREES_DIR}/src/.

Note that the archive will still be extracted into a subfolder underneath that directory (${WORKING_DIRECTORY}/${REF}-${HASH}/).

PATCHES

A list of patches to be applied to the extracted sources.

Relative paths are based on the port directory.

DISABLE_SSL

Disable ssl when downloading source.

NO_REMOVE_ONE_LEVEL

Specifies that the default removal of the top level folder should not occur.

Examples:

Source

scripts/cmake/vcpkg_from_sourceforge.cmake