Skip to content

[docs] CMake command docs say to use 0 for missing SHA512#18611

Merged
BillyONeal merged 1 commit intomicrosoft:masterfrom
Hamled:sha512-docs-fix
Jul 16, 2021
Merged

[docs] CMake command docs say to use 0 for missing SHA512#18611
BillyONeal merged 1 commit intomicrosoft:masterfrom
Hamled:sha512-docs-fix

Conversation

@Hamled
Copy link
Copy Markdown
Contributor

@Hamled Hamled commented Jun 23, 2021

Describe the pull request

  • What does your PR fix?

    This is a follow-up to the PR closing [vcpkg_download_distfile] Add condition for padding the SHA #18459 which made 0 the only value to use for SHA512 arguments which would result in showing the hash that vcpkg calculated when it didn't match.

    Some of the remaining documentation for vcpkg's CMake commands still directs users to put the value 1 when they do not yet know the correct hash. This PR fixes the documentation in those places that I was able to identify.

    It also adds the instructions about using the value 0 to the documentation for vcpkg_from_sourceforge because it did not have that line before. I believe this is correct because the code for that command uses the same vcpkg_download_distfile function that was changed, but I have not tested it myself.

@ghost
Copy link
Copy Markdown

ghost commented Jun 23, 2021

CLA assistant check
All CLA requirements met.

@JackBoosY JackBoosY added requires:vcpkg-team-review This PR or issue requires someone on the vcpkg team to take a further look. category:documentation To resolve the issue, documentation will need to be updated labels Jun 24, 2021
@Hamled Hamled changed the title CMake command docs say to use 0 for missing SHA512 [docs] CMake command docs say to use 0 for missing SHA512 Jun 24, 2021
@ras0219-msft
Copy link
Copy Markdown
Contributor

/azp run

@ras0219-msft
Copy link
Copy Markdown
Contributor

Thank you very much for the PR correcting this oversight! LGTM.

@azure-pipelines
Copy link
Copy Markdown

Azure Pipelines successfully started running 1 pipeline(s).

@JackBoosY JackBoosY added info:needs-maintainer-attention Lets the current 'on rotation' vcpkg maintainer know they need to look at this. and removed requires:vcpkg-team-review This PR or issue requires someone on the vcpkg team to take a further look. labels Jul 2, 2021
@BillyONeal BillyONeal merged commit bef043c into microsoft:master Jul 16, 2021
@BillyONeal
Copy link
Copy Markdown
Member

Thanks for the fix!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

category:documentation To resolve the issue, documentation will need to be updated info:needs-maintainer-attention Lets the current 'on rotation' vcpkg maintainer know they need to look at this.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants