vcpkg/docs/maintainers/vcpkg_install_copyright.md
Thomas1664 c69f2b9098
[vcpkg] Add vcpkg_install_copyright() portfile function ()
* [vcpkg tool] Add vcpkg_install_copyright

* Make sure FILE_LIST is provided

* relative to ${SOURCE_PATH}

* Add documentation

* Add to table of contents

* Relative paths was a bad idea.

* Tell users to use the correct way

Co-authored-by: Billy O'Neal <bion@microsoft.com>

* Fix docs

* Add parameter COMMENT

* Rename to vcpkg_concat_copyright

* Fix escape

* Revert "Fix escape"

This reverts commit 53f1636705.

* Revert "Rename to vcpkg_concat_copyright"

This reverts commit 6ce9152a61.

* Fix escape

* Add support for single copyright file

* Update docs

* Make comment less confusing

* [ci skip] Billy CR

* [ci skip] Format

* Remove explicit checks for STREQUAL ""

* Add error msg if file doesn't exist

Co-authored-by: Billy O'Neal <bion@microsoft.com>
2022-07-13 09:41:52 -07:00

1.6 KiB

vcpkg_install_copyright

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

Merges multiple copyright files into a single file and install it. Installs a single copyright file.

Usage

vcpkg_install_copyright(FILE_LIST <file1> <file2>... [COMMENT])

Parameters

FILE_LIST

Specifies a list of license files with absolute paths. You must provide at least one file.

COMMENT

This optional parameter adds a comment before at the top of the file.

Notes

This function creates a file called copyright inside ${CURRENT_PACKAGES_DIR}/share/${PORT}

If more than one file is provided, this function concatenates the contents of multiple copyright files to a single file.

The resulting copyright file looks similar to this:

LICENSE-LGPL2.txt:

Lorem ipsum dolor...

LICENSE-MIT.txt:

Lorem ipsum dolor sit amet...

Or with COMMENT:

A meaningful comment

LICENSE-LGPL2.txt:

Lorem ipsum dolor...

LICENSE-MIT.txt:

Lorem ipsum dolor sit amet...

Examples

vcpkg_install_copyright(FILE_LIST "${SOURCE_PATH}/LICENSE/license.md" "${SOURCE_PATH}/LICENSE/license_gpl.md" COMMENT "This is a comment")

You can also collect the required files using a GLOB pattern:

file(GLOB LICENSE_FILES "${SOURCE_PATH}/LICENSES/*")
vcpkg_install_copyright(FILE_LIST ${LICENSE_FILES})

Source

vcpkg_install_copyright.md