[vcpkg] Add optional 'Homepage' field to CONTROL (microsoft#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 microsoft#2933. It currently does not do anything with it. * [docs] Add Homepage to the control file documentation * move urls from descriptions to homepage field.
DomClark · Jun 10, 2019 · d962dc7 · d962dc7
1 parent 06d5d39
commit d962dc7
Show file tree

Hide file tree

Showing 48 changed files with 99 additions and 46 deletions.
diff --git 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.
 

diff --git a/ports/alembic/CONTROL b/ports/alembic/CONTROL
@@ -1,4 +1,5 @@
 Source: alembic
 Version: 1.7.11
 Build-Depends: ilmbase, hdf5
-Description: Alembic is an open framework for storing and sharing scene data that includes a C++ library, a file format, and client plugins and applications. http://alembic.io/
+Description: Alembic is an open framework for storing and sharing scene data that includes a C++ library, a file format, and client plugins and applications.
+Homepage: http://alembic.io/
diff --git a/ports/anax/CONTROL b/ports/anax/CONTROL
@@ -1,3 +1,4 @@
 Source: anax
 Version: 2.1.0-5
-Description: An open source C++ entity system. <https://github.com/miguelmartin75/anax>
+Description: An open source C++ entity system.
+Homepage: https://github.com/miguelmartin75/anax
diff --git a/ports/autobahn/CONTROL b/ports/autobahn/CONTROL
@@ -1,4 +1,5 @@
 Source: autobahn
 Version: 18.4.1
 Build-Depends: websocketpp, msgpack, boost-asio, boost-thread
-Description: WAMP for C++ in Boost/Asio https://crossbar.io/autobahn
+Description: WAMP for C++ in Boost/Asio 
+Homepage: https://crossbar.io/autobahn
diff --git a/ports/azure-storage-cpp/CONTROL b/ports/azure-storage-cpp/CONTROL
@@ -2,4 +2,5 @@ Source: azure-storage-cpp
 Version: 6.1.0
 Build-Depends: cpprestsdk[core], atlmfc (windows), boost-log (!windows&!uwp), boost-locale (!windows&!uwp), libxml2 (!windows&!uwp), libuuid (!windows&!uwp&!osx), gettext
 Description: Microsoft Azure Storage Client SDK for C++
-  A client library for working with Microsoft Azure storage services including blobs, files, tables, and queues. This client library enables working with the Microsoft Azure storage services which include the blob service for storing binary and text data, the file service for storing binary and text data, the table service for storing structured non-relational data, and the queue service for storing messages that may be accessed by a client. Microsoft Azure Storage team's blog - http://blogs.msdn.com/b/windowsazurestorage/
+  A client library for working with Microsoft Azure storage services including blobs, files, tables, and queues. This client library enables working with the Microsoft Azure storage services which include the blob service for storing binary and text data, the file service for storing binary and text data, the table service for storing structured non-relational data, and the queue service for storing messages that may be accessed by a client.
+Homepage: http://blogs.msdn.com/b/windowsazurestorage/
diff --git a/ports/bond/CONTROL b/ports/bond/CONTROL
@@ -1,5 +1,6 @@
 Source: bond
 Maintainer: [email protected]
 Version: 7.0.2-2
-Description: Bond is a cross-platform framework for working with schematized data. It supports cross-language de/serialization and powerful generic mechanisms for efficiently manipulating data. Bond is broadly used at Microsoft in high scale services. <https://github.com/Microsoft/bond>
+Description: Bond is a cross-platform framework for working with schematized data. It supports cross-language de/serialization and powerful generic mechanisms for efficiently manipulating data. Bond is broadly used at Microsoft in high scale services.
+Homepage: https://github.com/Microsoft/bond
 Build-Depends: rapidjson, boost-config, boost-utility, boost-assign
diff --git a/ports/box2d/CONTROL b/ports/box2d/CONTROL
@@ -1,3 +1,4 @@
 Source: box2d
 Version: 2.3.1-374664b-2
-Description: Box2D (http://box2d.org) is an open source C++ engine for simulating rigid bodies in 2D.
+Description: An open source C++ engine for simulating rigid bodies in 2D.
+Homepage: http://box2d.org
diff --git a/ports/capnproto/CONTROL b/ports/capnproto/CONTROL
@@ -1,4 +1,5 @@
 Source: capnproto
 Version: 0.7.0-1
-Description: Data interchange format and capability-based RPC system https://capnproto.org/
+Description: Data interchange format and capability-based RPC system
+Homepage: https://capnproto.org/
 Build-Depends: zlib
diff --git a/ports/catch2/CONTROL b/ports/catch2/CONTROL
@@ -1,4 +1,4 @@
 Source: catch2
 Version: 2.7.2
 Description: A modern, header-only test framework for unit testing.
-  Issues, PRs and changelogs can be found at https://github.com/catchorg/Catch2
+Homepage: https://github.com/catchorg/Catch2
diff --git a/ports/cli11/CONTROL b/ports/cli11/CONTROL
@@ -1,3 +1,4 @@
 Source: cli11
 Version: 1.8.0
-Description: CLI11 is a command line parser for C++11 and beyond that provides a rich feature set with a simple and intuitive interface. <https://github.com/CLIUtils/CLI11>
+Description: CLI11 is a command line parser for C++11 and beyond that provides a rich feature set with a simple and intuitive interface.
+Homepage: https://github.com/CLIUtils/CLI11
diff --git a/ports/corrade/CONTROL b/ports/corrade/CONTROL
@@ -1,6 +1,7 @@
 Source: corrade
 Version: 2019.01-1
-Description: C++11/C++14 multiplatform utility library http://magnum.graphics/corrade/
+Description: C++11/C++14 multiplatform utility library
+Homepage: http://magnum.graphics/corrade/
 Default-Features: interconnect, pluginmanager, testsuite, utility
 
 Feature: interconnect

diff --git a/ports/entityx/CONTROL b/ports/entityx/CONTROL
@@ -1,3 +1,4 @@
 Source: entityx
 Version: 1.3.0-1
-Description: EntityX - A fast, type-safe C++ Entity-Component system. <https://github.com/alecthomas/entityx>
+Description: EntityX - A fast, type-safe C++ Entity-Component system.
+Homepage: https://github.com/alecthomas/entityx
diff --git a/ports/entt/CONTROL b/ports/entt/CONTROL
@@ -1,3 +1,4 @@
 Source: entt
 Version: 3.0.0-1
-Description: Gaming meets modern C++ - a fast and reliable entity-component system and much more. <https://github.com/skypjack/entt>
+Description: Gaming meets modern C++ - a fast and reliable entity-component system and much more.
+Homepage: https://github.com/skypjack/entt
diff --git a/ports/exiv2/CONTROL b/ports/exiv2/CONTROL
@@ -1,7 +1,8 @@
 Source: exiv2
 Version: 0.27
 Build-Depends: zlib, expat, libiconv, gettext
-Description: Image metadata library and tools http://www.exiv2.org
+Description: Image metadata library and tools
+Homepage: http://www.exiv2.org
 
 Feature: unicode
 Description: Compile with unicode support on windows
diff --git a/ports/flatbuffers/CONTROL b/ports/flatbuffers/CONTROL
@@ -1,4 +1,5 @@
 Source: flatbuffers
 Version: 1.11.0
-Description: Memory Efficient Serialization Library http://google.github.io/flatbuffers/
+Description: Memory Efficient Serialization Library
  FlatBuffers is an efficient cross platform serialization library for games and other memory constrained apps. It allows you to directly access serialized data without unpacking/parsing it first, while still having great forwards/backwards compatibility.
+Homepage:  http://google.github.io/flatbuffers/
diff --git a/ports/fmilib/CONTROL b/ports/fmilib/CONTROL
@@ -1,3 +1,4 @@
 Source: fmilib
 Version: 2.0.3-1
-Description: FMI library is intended as a foundation for applications interfacing FMUs (Functional Mockup Units) that follow FMI Standard. This version of the library supports FMI 1.0 and FMI2.0. See http://www.fmi-standard.org/
+Description: FMI library is intended as a foundation for applications interfacing FMUs (Functional Mockup Units) that follow FMI Standard. This version of the library supports FMI 1.0 and FMI2.0.
+Homepage: http://www.fmi-standard.org/
diff --git a/ports/g2o/CONTROL b/ports/g2o/CONTROL
@@ -1,4 +1,5 @@
 Source: g2o
 Version: 20170730_git-4
 Build-Depends: suitesparse, eigen3, clapack (!osx), ceres
-Description: g2o: A General Framework for Graph Optimization http://openslam.org/g2o.html
+Description: g2o: A General Framework for Graph Optimization
+Homepage: http://openslam.org/g2o.html
diff --git a/ports/getopt-win32/CONTROL b/ports/getopt-win32/CONTROL
@@ -1,3 +1,4 @@
 Source: getopt-win32
 Version: 0.1
-Description: An implementation of getopt provided by https://github.com/libimobiledevice-win32
+Description: An implementation of getopt.
+Homepage: https://github.com/libimobiledevice-win32
diff --git a/ports/gli/CONTROL b/ports/gli/CONTROL
@@ -1,4 +1,5 @@
 Source: gli
 Version: dd17acf
 Build-Depends: glm
-Description: OpenGL Image (GLI) https://gli.g-truc.net
+Description: OpenGL Image (GLI)
+Homepage: https://gli.g-truc.net
diff --git a/ports/glibmm/CONTROL b/ports/glibmm/CONTROL
@@ -1,4 +1,5 @@
 Source: glibmm
 Version: 2.52.1-9
-Description: This is glibmm, a C++ API for parts of glib that are useful for C++. See http://www.gtkmm.org.
+Description: This is glibmm, a C++ API for parts of glib that are useful for C++.
+Homepage: http://www.gtkmm.org.
 Build-Depends: zlib, pcre, libffi, gettext, libiconv, glib, libsigcpp
diff --git a/ports/glm/CONTROL b/ports/glm/CONTROL
@@ -1,3 +1,4 @@
 Source: glm
 Version: 0.9.9.5-3
-Description: OpenGL Mathematics (GLM) https://glm.g-truc.net
+Description: OpenGL Mathematics (GLM)
+Homepage: https://glm.g-truc.net
diff --git a/ports/globjects/CONTROL b/ports/globjects/CONTROL
@@ -2,4 +2,5 @@ Source: globjects
 Maintainer: [email protected]
 Version: 1.1.0-2018-09-19-1
 Build-Depends: glbinding, glm
-Description: C++ library strictly wrapping OpenGL objects. <https://github.com/cginternals/globjects>
+Description: C++ library strictly wrapping OpenGL objects.
+Homepage: https://github.com/cginternals/globjects
diff --git a/ports/kd-soap/CONTROL b/ports/kd-soap/CONTROL
@@ -1,4 +1,5 @@
 Source: kd-soap
 Version: 1.8.0
-Description: A Qt-based client-side and server-side SOAP component http://www.kdab.com/products/kd-soap
+Description: A Qt-based client-side and server-side SOAP component
+Homepage: http://www.kdab.com/products/kd-soap
 Build-Depends: qt5-base
diff --git a/ports/magnum-extras/CONTROL b/ports/magnum-extras/CONTROL
@@ -1,7 +1,8 @@
 Source: magnum-extras
 Version: 2019.01-1
 Build-Depends: magnum[core]
-Description: Extras for magnum, C++11/C++14 graphics middleware for games and data visualization http://magnum.graphics/
+Description: Extras for magnum, C++11/C++14 graphics middleware for games and data visualization 
+Homepage: http://magnum.graphics/
 Default-Features:
 
 Feature: ui

diff --git a/ports/magnum-integration/CONTROL b/ports/magnum-integration/CONTROL
@@ -1,7 +1,8 @@
 Source: magnum-integration
 Version: 2019.01-1
 Build-Depends: magnum[core]
-Description: Integrations for magnum, C++11/C++14 graphics middleware for games and data visualization http://magnum.graphics/
+Description: Integrations for magnum, C++11/C++14 graphics middleware for games and data visualization 
+Homepage: http://magnum.graphics/
 Default-Features:
 
 Feature: bullet

diff --git a/ports/magnum-plugins/CONTROL b/ports/magnum-plugins/CONTROL
@@ -1,7 +1,8 @@
 Source: magnum-plugins
 Version: 2019.01-1
 Build-Depends: magnum[core]
-Description: Plugins for magnum, C++11/C++14 graphics middleware for games and data visualization http://magnum.graphics/
+Description: Plugins for magnum, C++11/C++14 graphics middleware for games and data visualization 
+Homepage: http://magnum.graphics/
 Default-Features: ddsimporter, miniexrimageconverter, opengeximporter, stanfordimporter, stbimageconverter, stbimageimporter
 
 Feature: assimpimporter

diff --git a/ports/magnum/CONTROL b/ports/magnum/CONTROL
@@ -1,7 +1,8 @@
 Source: magnum
 Version: 2019.01-1
 Build-Depends: corrade[utility]
-Description: C++11/C++14 graphics middleware for games and data visualization http://magnum.graphics/
+Description: C++11/C++14 graphics middleware for games and data visualization 
+Homepage: http://magnum.graphics/
 Default-Features: anyimageimporter, anyaudioimporter, anyimageconverter, anysceneimporter, debugtools, gl, meshtools, primitives, scenegraph, shaders, text, texturetools, trade, sdl2application
 
 Feature: al-info

diff --git a/ports/mdnsresponder/CONTROL b/ports/mdnsresponder/CONTROL
@@ -1,3 +1,4 @@
 Source: mdnsresponder
 Version: 765.30.11
-Description: The mDNSResponder project is a component of Bonjour, Apple's ease-of-use IP networking initiative: <http://developer.apple.com/bonjour/>
+Description: The mDNSResponder project is a component of Bonjour, Apple's ease-of-use IP networking initiative.
+Homepage: http://developer.apple.com/bonjour/
diff --git a/ports/minisat-master-keying/CONTROL b/ports/minisat-master-keying/CONTROL
@@ -2,4 +2,4 @@ Source: minisat-master-keying
 Version: 2.2-mod-2
 Description: A minimalistic high-performance SAT solver
   This is a modernized, cross-platform, CMake-enabled fork of the original MiniSat. 
-  Since the original library is no longer under development, post issues and pull requests should be posted to https://github.com/master-keying/minisat
+Homepage: https://github.com/master-keying/minisat
diff --git a/ports/moos-core/CONTROL b/ports/moos-core/CONTROL
@@ -1,3 +1,4 @@
 Source: moos-core
 Version: 10.4.0-2
-Description: A very light weight, easy to use middleware. See the MOOS homepage at https://sites.google.com/site/moossoftware/ for more information and documentation.
+Description: A very light weight, easy to use middleware.
+Homepage: https://sites.google.com/site/moossoftware/
diff --git a/ports/moos-essential/CONTROL b/ports/moos-essential/CONTROL
@@ -1,4 +1,5 @@
 Source: moos-essential
 Version: 10.0.1-1
-Description: a set of useful applications that leverage the core-moos communications layer See the MOOS homepage at https://sites.google.com/site/moossoftware/ for more information and documentation.
+Description: a set of useful applications that leverage the core-moos communications layer.
+Homepage: https://sites.google.com/site/moossoftware/
 Build-Depends: moos-core
diff --git a/ports/moos-ui/CONTROL b/ports/moos-ui/CONTROL
@@ -1,6 +1,7 @@
 Source: moos-ui
 Version: 10.0.1-1
-Description: set of user interface tools to use and leverage the MOOS project. See the MOOS homepage at https://sites.google.com/site/moossoftware/ for more information and documentation.
+Description: set of user interface tools to use and leverage the MOOS project.
+Homepage: https://sites.google.com/site/moossoftware/
 Build-Depends: moos-core
 
 
diff --git a/ports/mosquitto/CONTROL b/ports/mosquitto/CONTROL
@@ -3,4 +3,4 @@ Version: 1.5.0-3
 Build-Depends: c-ares, libwebsockets, openssl, pthreads
 Description: Mosquitto is an open source message broker that implements the MQ Telemetry Transport protocol versions 3.1 and 3.1.1.
   MQTT provides a lightweight method of carrying out messaging using a publish/subscribe model. This makes it suitable for "machine to machine" messaging such as with low power sensors or mobile devices such as phones, embedded computers or microcontrollers like the Arduino.
-  You can see more information from this url https://mosquitto.org/download/
+Homepage: https://mosquitto.org/download/
diff --git a/ports/opentracing/CONTROL b/ports/opentracing/CONTROL
@@ -1,3 +1,4 @@
 Source: opentracing
 Version: 1.5.1
-Description: C++ implementation of the OpenTracing API http://opentracing.io
+Description: C++ implementation of the OpenTracing API 
+Homepage: http://opentracing.io
diff --git a/ports/poco/CONTROL b/ports/poco/CONTROL
@@ -1,7 +1,8 @@
 Source: poco
 Version: 2.0.0-pre-1
 Build-Depends: expat, libpq, pcre, sqlite3, zlib
-Description: Modern, powerful open source C++ class libraries for building network and internet-based applications that run on desktop, server, mobile and embedded systems. (https://github.com/pocoproject/poco)
+Description: Modern, powerful open source C++ class libraries for building network and internet-based applications that run on desktop, server, mobile and embedded systems.
+Homepage: https://github.com/pocoproject/poco
 
 Feature: mysql
 Build-Depends: libmysql

diff --git a/ports/qca/CONTROL b/ports/qca/CONTROL
@@ -1,4 +1,5 @@
 Source: qca
 Version: 2.2.1
-Description: Qt Cryptographic Architecture (QCA). Sources: https://cgit.kde.org/qca.git/
+Description: Qt Cryptographic Architecture (QCA).
+Homepage: https://cgit.kde.org/qca.git/
 Build-Depends: qt5-base
diff --git a/ports/rapidjson/CONTROL b/ports/rapidjson/CONTROL
@@ -1,3 +1,4 @@
 Source: rapidjson
 Version: 1.1.0-3
-Description: A fast JSON parser/generator for C++ with both SAX/DOM style API <http://rapidjson.org/>
+Description: A fast JSON parser/generator for C++ with both SAX/DOM style API
+Homepage: http://rapidjson.org/
diff --git a/ports/readline-win32/CONTROL b/ports/readline-win32/CONTROL
@@ -1,3 +1,4 @@
 Source: readline-win32
 Version: 5.0-2
-Description: Implementation of readline for Windows Desktop provided by https://github.com/lltcggie
+Description: Implementation of readline for Windows Desktop
+Homepage: https://github.com/lltcggie
diff --git a/ports/rxqt/CONTROL b/ports/rxqt/CONTROL
@@ -1,4 +1,5 @@
 Source: rxqt
 Version: bb2138c
-Description: The Reactive Extensions for Qt. <https://github.com/tetsurom/rxqt>
+Description: The Reactive Extensions for Qt.
+Homepage: https://github.com/tetsurom/rxqt
 Build-Depends: rxcpp
diff --git a/ports/sdl2pp/CONTROL b/ports/sdl2pp/CONTROL
@@ -1,4 +1,5 @@
 Source: sdl2pp
 Version: 0.16.0-1
-Description: C++11 bindings/wrapper for SDL2 https://sdl2pp.amdmi3.ru
+Description: C++11 bindings/wrapper for SDL2
+Homepage: https://sdl2pp.amdmi3.ru
 Build-Depends: sdl2, sdl2-mixer, sdl2-image, sdl2-ttf
diff --git a/ports/spectra/CONTROL b/ports/spectra/CONTROL
@@ -1,4 +1,5 @@
 Source: spectra
 Version: 0.8.0
-Description: A header-only C++ library for large scale eigenvalue problems https://spectralib.org
+Description: A header-only C++ library for large scale eigenvalue problems
+Homepage: https://spectralib.org
 Build-Depends: eigen3
diff --git a/ports/think-cell-range/CONTROL b/ports/think-cell-range/CONTROL
@@ -1,5 +1,6 @@
 Source: think-cell-range
 Maintainer: [email protected]
 Version: 498839d-1
-Description: think-cell's range library <https://think-cell.com>, <https://github.com/think-cell/range>, <https://www.think-cell.com/en/career/talks/ranges/#1>
+Description: think-cell's range library
+Homepage: https://github.com/think-cell/range
 Build-Depends: boost
diff --git a/ports/treehopper/CONTROL b/ports/treehopper/CONTROL
@@ -1,3 +1,4 @@
 Source: treehopper
 Version: 1.11.3-2
-Description: Treehopper connects the physical world to your computer, tablet, or smartphone. For more information, visit https://treehopper.io.
+Description: Treehopper connects the physical world to your computer, tablet, or smartphone.
+Homepage: https://treehopper.io
diff --git a/ports/trompeloeil/CONTROL b/ports/trompeloeil/CONTROL
@@ -1,4 +1,4 @@
 Source: trompeloeil
 Version: 34
 Description: A thread-safe header-only mocking framework for C++11/14 using the Boost Software License 1.0
-    For issues/pull requests/questions visit https://github.com/rollbear/trompeloeil
+Homepage: https://github.com/rollbear/trompeloeil
diff --git a/ports/uvw/CONTROL b/ports/uvw/CONTROL
@@ -1,4 +1,5 @@
 Source: uvw
 Version: 1.17.0_libuv-v1.29
-Description: Header-only, event based, tiny and easy to use libuv wrapper in modern C++. <https://github.com/skypjack/uvw>
+Description: Header-only, event based, tiny and easy to use libuv wrapper in modern C++.
+Homepage: https://github.com/skypjack/uvw
 Build-Depends: libuv
diff --git a/ports/zstd/CONTROL b/ports/zstd/CONTROL
@@ -1,3 +1,4 @@
 Source: zstd
 Version: 1.4.0
-Description: Zstandard - Fast real-time compression algorithm http://www.zstd.net
+Description: Zstandard - Fast real-time compression algorithm
+Homepage: http://www.zstd.net
diff --git a/toolsrc/include/vcpkg/sourceparagraph.h b/toolsrc/include/vcpkg/sourceparagraph.h
@@ -48,6 +48,7 @@ namespace vcpkg
         std::string version;
         std::string description;
         std::string maintainer;
+        std::string homepage;
         std::vector<std::string> supports;
         std::vector<Dependency> depends;
         std::vector<std::string> default_features;

diff --git a/toolsrc/src/vcpkg/sourceparagraph.cpp b/toolsrc/src/vcpkg/sourceparagraph.cpp
@@ -24,6 +24,7 @@ namespace vcpkg
         static const std::string SOURCE = "Source";
         static const std::string SUPPORTS = "Supports";
         static const std::string VERSION = "Version";
+        static const std::string HOMEPAGE = "Homepage";
     }
 
     static Span<const std::string> get_list_of_valid_fields()
@@ -34,6 +35,7 @@ namespace vcpkg
             SourceParagraphFields::DESCRIPTION,
             SourceParagraphFields::MAINTAINER,
             SourceParagraphFields::BUILD_DEPENDS,
+            SourceParagraphFields::HOMEPAGE,
         };
 
         return valid_fields;
@@ -107,6 +109,7 @@ namespace vcpkg
 
         spgh->description = parser.optional_field(SourceParagraphFields::DESCRIPTION);
         spgh->maintainer = parser.optional_field(SourceParagraphFields::MAINTAINER);
+        spgh->homepage = parser.optional_field(SourceParagraphFields::HOMEPAGE);
         spgh->depends = expand_qualified_dependencies(
             parse_comma_list(parser.optional_field(SourceParagraphFields::BUILD_DEPENDS)));
         spgh->supports = parse_comma_list(parser.optional_field(SourceParagraphFields::SUPPORTS));