diff options
| author | Jack·Boos·Yu <47264268+JackBoosY@users.noreply.github.com> | 2020-06-27 06:06:30 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-06-26 15:06:30 -0700 |
| commit | a0e0c57f865937cdda81c21ad9327e606f7dc930 (patch) | |
| tree | 86b0d97dd67594d12f3283c1c46cc5e690c1a258 /docs | |
| parent | 81ae2ed94bf51fdd453b383135a809dea3d45cce (diff) | |
| download | vcpkg-a0e0c57f865937cdda81c21ad9327e606f7dc930.tar.gz vcpkg-a0e0c57f865937cdda81c21ad9327e606f7dc930.zip | |
[vcpkg] Add vcpkg_from_sourceforge (1/2) (#11899)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/maintainers/vcpkg_from_sourceforge.md | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/docs/maintainers/vcpkg_from_sourceforge.md b/docs/maintainers/vcpkg_from_sourceforge.md new file mode 100644 index 000000000..823ee82f9 --- /dev/null +++ b/docs/maintainers/vcpkg_from_sourceforge.md @@ -0,0 +1,63 @@ +# vcpkg_from_sourceforge
+
+Download and extract a project from sourceforge.
+
+## Usage:
+```cmake
+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.
+
+### 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:
+
+* [cunit](https://github.com/Microsoft/vcpkg/blob/master/ports/cunit/portfile.cmake)
+* [polyclipping](https://github.com/Microsoft/vcpkg/blob/master/ports/polyclipping/portfile.cmake)
+* [tinyfiledialogs](https://github.com/Microsoft/vcpkg/blob/master/ports/tinyfiledialogs/portfile.cmake)
+
+## Source
+[scripts/cmake/vcpkg_from_sourceforge.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_from_sourceforge.cmake)
|