From d962dc7d651b563bed089f4bf9056003ebb7fe1c Mon Sep 17 00:00:00 2001 From: Phil Christensen Date: Mon, 10 Jun 2019 16:35:22 -0700 Subject: [vcpkg] Add optional 'Homepage' field to CONTROL (#6844) * [control file] Add optional 'Homepage' tag This allows a 'Homepage' tag to be added to a port in order to support changes such as PR #2933. It currently does not do anything with it. * [docs] Add Homepage to the control file documentation * move urls from descriptions to homepage field. --- docs/maintainers/control-files.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/maintainers/control-files.md b/docs/maintainers/control-files.md index a8f430836..ac4afa265 100644 --- a/docs/maintainers/control-files.md +++ b/docs/maintainers/control-files.md @@ -56,7 +56,7 @@ Version: 2019-3-21 ``` #### Description -A description of the library +A description of the library. By convention the first line of the description is a summary of the library. An optional detailed description follows. The detailed description can be multiple lines, all starting with whitespace. @@ -70,6 +70,14 @@ Description: Mosquitto is an open source message broker that implements the MQ T to machine" messaging such as with low power sensors or mobile devices such as phones, embedded computers or microcontrollers like the Arduino. ```` +#### Homepage +The URL of the homepage for the library where a user is able to find additional documentation or the original source code. + +Example: +```no-highlight +Homepage: https://github.com/Microsoft/vcpkg +``` + #### Build-Depends Comma separated list of vcpkg ports the library has a dependency on. -- cgit v1.2.3