vcpkg icon indicating copy to clipboard operation
vcpkg copied to clipboard

[multiple] Add usage files for 20 ports

Open ozacod opened this issue 2 weeks ago • 4 comments

Added usage files for:

  • 3fd

  • 7zip

  • ableton-link

  • absent

  • ace

  • acl

  • activemq-cpp

  • ada-idna

  • ada-url

  • ade

  • air-ctl

  • aixlog

  • alac

  • alac-decoder

  • alembic

  • aliyun-oss-c-sdk

  • alpaca

  • amd-adl-sdk

  • ampl-asl

  • ampl-mp

  • [x] Changes comply with the maintainer guide.

  • [ ] SHA512s are updated for each updated download.

  • [ ] The "supports" clause reflects platforms that may be fixed by this new version.

  • [ ] Any fixed CI baseline entries are removed from that file.

  • [ ] Any patches that are no longer applied are deleted from the port's directory.

  • [ ] The version database is fixed by rerunning ./vcpkg x-add-version --all and committing the result.

  • [ ] Only one version is added to each modified port's versions file.

ozacod avatar Dec 08 '25 12:12 ozacod

@microsoft-github-policy-service agree

@ozacod please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

@microsoft-github-policy-service agree

ozacod avatar Dec 08 '25 12:12 ozacod

"usage" information is a dynamic service from the vcpkg tool on vcpkg install port. There is heuristical output for cmake config and pkg-config usage. AFAICT explicit usage files are for cases where the heuristics fail to provide good output. When a usage file is needed, it makes sense to use the same formatting as the heuristical output. And the files must be installed.

dg0yt avatar Dec 08 '25 19:12 dg0yt

I'm happy to replace heuristics with a real usage file but we should not merely take the heuristic and check in an identical usage file; removing the warning that it's a detected target should only be done after we have some form of confirmation that the targets actually do the correct thing for users.

Have you built test programs that use all of these targets you can show us to confirm that they actually work? If so we may want to consider adding those as test ports.

BillyONeal avatar Dec 09 '25 03:12 BillyONeal

Based on CI file lists for x64-windows, there is at least one port with pkg-config usage:
ada-url:x64-windows:/lib/pkgconfig/ada.pc

(FTR I occassionally remove usage files in port updates if they don't add value or even reduce value.)

dg0yt avatar Dec 09 '25 08:12 dg0yt

After discussion with @vicroms , @MahmoudGSaleh , and @AugP : In order to change a usage we want to see:

  1. A demonstration that the automatically generated usage is incorrect
  2. A demonstration that the replacement usage is correct

It seems unlikely that these usages have been tested given @dg0yt found a counterexample above...

BillyONeal avatar Dec 10 '25 22:12 BillyONeal

It seems unlikely that these usages have been tested

+1 to this. ace doesn't even install cmake config.

Osyotr avatar Dec 12 '25 15:12 Osyotr

I'm going to close these on the basis that they are unlikely to be a starting point in adding correct usages. Please feel free to open new PRs with usages consistent with the statement above:

After discussion with @vicroms , @MahmoudGSaleh , and @AugP : In order to change a usage we want to see:

  1. A demonstration that the automatically generated usage is incorrect
  2. A demonstration that the replacement usage is correct

It seems unlikely that these usages have been tested given @dg0yt found a counterexample above...

BillyONeal avatar Dec 17 '25 21:12 BillyONeal