Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Add a Homepage URL entry for vcpkg ports #2933

Merged
merged 16 commits into from
Jun 15, 2019

Conversation

pravic
Copy link
Contributor

@pravic pravic commented Mar 2, 2018

Fixes #1642.

When browsing new ports, it is often hard to understand their purpose. Or where they come from (without looking into portfile.cmake). Some examples: http-parser, ode, and lots of others.

The idea was to add a human readable URL in port's description, thus vcpkg could print it in vcpkg list and vcpkg search results. However I am not sure about the best place for URL at the moment, so it is an open question.

This PR does not implement corresponding changes in vcpkg source (to support the new field), it just adds a Homepage entry to almost all ports (except empty ones like winsock2 or atlmfc and except modularized subports like qt5- or boost-). URLs are extracted from vcpkg_from_github, vcpkg_from_bitbucket, vcpkg_download_distfile so they can be not perfect, but it is the best I can do :)

Unresolved questions:

  1. The name of the homepage entry in CONTROL files. Homepage? URL? Repository? Actually, most of repositories use multiple entries (homepage and repository in Rust crates, homepage, download and issue tracker URLs in pypi and so on).
  2. Do we need to print URLs or we can leave them in CONTROL files just for manual reading? Personally, I would go without print.
  3. If we are going to print, when and where? Descriptions often quite big and do not fit in one line in console.
  4. May be introduce an additional command similar to cargo-show (pip show, npm view, etc.) which will print all information about particular port?

@jasjuang
Copy link
Contributor

jasjuang commented Mar 3, 2018

This is a great idea

@soul4soul
Copy link

  1. I vote for Homepage. It should be a URL to the webpage which is the primary entry point into learning about the port. For software which has a dedicated website it would be a URL to that website. Other software with no dedicated website would be a URL to the github repo.
  2. See 3.
  3. See 3.
  4. I vote for having a show command which would print all of the information about a particular port.

Why would not include HomePage for each subport too?

@luzpaz
Copy link
Contributor

luzpaz commented Feb 13, 2019

This would be very useful. Is there an ETA on when this will be merged ?

@Cheney-W Cheney-W added the wip label Mar 7, 2019
@Rastaban Rastaban self-assigned this May 2, 2019
Rastaban added a commit to Rastaban/vcpkg that referenced this pull request Jun 10, 2019
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.
ras0219-msft pushed a commit that referenced this pull request Jun 10, 2019
* [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.
@Rastaban
Copy link
Contributor

/azp run

@Rastaban
Copy link
Contributor

Rastaban commented Jun 15, 2019

The only failure is shogun:x64-linux and looks like it is unrelated to this PR. It should probably not hold up this PR.

Update: on rerun the port passed, it is probably just a flaky port.

@Rastaban Rastaban merged commit 18b029a into microsoft:master Jun 15, 2019
@MVoz
Copy link
Contributor

MVoz commented Jun 16, 2019

@Rastaban add in templates ?
vcpkg\scripts\templates\CONTROL.in

Source: @PORT@
Version: 
#Homepage: 
Description: 
#Build-Depends: 

@pravic pravic deleted the port-source-urls branch January 18, 2020 04:02
strega-nil pushed a commit to strega-nil/vcpkg that referenced this pull request May 5, 2021
* [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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Links to project source repository in CONTROL?
7 participants