diff options
| author | Phil Christensen <philc@microsoft.com> | 2019-06-10 16:35:22 -0700 |
|---|---|---|
| committer | Robert Schumacher <roschuma@microsoft.com> | 2019-06-10 16:35:22 -0700 |
| commit | d962dc7d651b563bed089f4bf9056003ebb7fe1c (patch) | |
| tree | 12583d7562888f47d0759d94bf5bc2d2da8284c1 /docs | |
| parent | 06d5d393b962604ae0a0f8fa6cfd1a89d0627e83 (diff) | |
| download | vcpkg-d962dc7d651b563bed089f4bf9056003ebb7fe1c.tar.gz vcpkg-d962dc7d651b563bed089f4bf9056003ebb7fe1c.zip | |
[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.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/maintainers/control-files.md | 10 |
1 files changed, 9 insertions, 1 deletions
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. |