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

[vcpkg docs] Remove deprecated functions from docs #23018

Merged
merged 4 commits into from
Feb 18, 2022

Conversation

Thomas1664
Copy link
Contributor

Describe the pull request

@JonLiu1993 JonLiu1993 self-assigned this Feb 10, 2022
@JonLiu1993 JonLiu1993 added the category:documentation To resolve the issue, documentation will need to be updated label Feb 10, 2022
@JonLiu1993
Copy link
Member

@Thomas1664 ,Thanks for your pr, It looks like CI is failing because of format issues, could you please take a look?

Starting: Create Diff
==============================================================================
Task         : PowerShell
Description  : Run a PowerShell script on Linux, macOS, or Windows
Version      : 2.198.0
Author       : Microsoft Corporation
Help         : https://docs.microsoft.com/azure/devops/pipelines/tasks/utility/powershell
==============================================================================
Generating script.
Formatted command: . 'C:\a\1\s\scripts\azure-pipelines\Create-PRDiff.ps1' -DiffFile 'C:\a\1\a\format.diff'
========================== Starting Command Output ===========================
"C:\Program Files\PowerShell\7\pwsh.exe" -NoLogo -NoProfile -NonInteractive -ExecutionPolicy Unrestricted -Command ". 'C:\a\_temp\d4f86608-513d-41dd-a143-1ed4b4d61128.ps1'"
C:\a\1\s\scripts\azure-pipelines\Create-PRDiff.ps1 : The formatting of the files in the repo were not what we expected,
or the documentation was not regenerated.
Please access the diff from format.diff in the build artifacts,
and apply the patch with `git apply`
At C:\a\_temp\d4f86608-513d-41dd-a143-1ed4b4d61128.ps1:3 char:1
+ . 'C:\a\1\s\scripts\azure-pipelines\Create-PRDiff.ps1' -DiffFile 'C:\ …
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo          : NotSpecified: (:) [Write-Error], WriteErrorException
+ FullyQualifiedErrorId : Microsoft.PowerShell.Commands.WriteErrorException,Create-PRDiff.ps1
##[error]PowerShell exited with code '1'.
Finishing: Create Diff

@Thomas1664
Copy link
Contributor Author

@JonLiu1993
I found out that I needed to edit the .cmake files and not the .md files. Do I really need to revert the changes in those .md files?

@dg0yt
Copy link
Contributor

dg0yt commented Feb 10, 2022

Nothing needed to revert. Just apply the original changes to the scripts. Then regenerate the doc files with the powershell script in the doc dir.

@Thomas1664
Copy link
Contributor Author

Nothing needed to revert. Just apply the original changes to the scripts. Then regenerate the doc files with the powershell script in the doc dir.

I applied the changes in the scripts. The powershell script doesn't work because I get a bunch of errors.

@dg0yt
Copy link
Contributor

dg0yt commented Feb 10, 2022

The powershell script doesn't work because I get a bunch of errors.

That's a pity. It works in CI and even on Linux.

@Thomas1664
Copy link
Contributor Author

That's a pity. It works in CI and even on Linux.

Hopefully I don't need to run it because I edited the docs already directly. Lets see if CI complains...

@Thomas1664
Copy link
Contributor Author

Great! Now that I edited the scripts CI builds every port

@dg0yt
Copy link
Contributor

dg0yt commented Feb 10, 2022

Great! Now that I edited the scripts CI builds every port

... that depends on the scripts. Last time discussed here: #21763 (comment) ff.

@Thomas1664
Copy link
Contributor Author

Thanks for your pr, It looks like CI is failing because of format issues, could you please take a look?

@JonLiu1993 , x86-windows succeeded, no need to run the ps script.

@JonLiu1993
Copy link
Member

colmap:x64-osx : this error is not introduced by this pr, we are fixing CI

@PhoebeHui PhoebeHui changed the title Remove deprecated functions from docs [vcpkg docs] Remove deprecated functions from docs Feb 14, 2022
@JackBoosY JackBoosY added the info:reviewed Pull Request changes follow basic guidelines label Feb 14, 2022
@BillyONeal BillyONeal added requires:author-response and removed info:reviewed Pull Request changes follow basic guidelines labels Feb 16, 2022
@BillyONeal BillyONeal added the info:reviewed Pull Request changes follow basic guidelines label Feb 17, 2022
@BillyONeal BillyONeal closed this Feb 17, 2022
@BillyONeal BillyONeal reopened this Feb 17, 2022
@BillyONeal
Copy link
Member

Cycled the PR in order to get CLA bot to be happy

@vicroms vicroms merged commit f7db911 into microsoft:master Feb 18, 2022
@Thomas1664 Thomas1664 deleted the deprecated-docs branch March 4, 2022 22:51
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:reviewed Pull Request changes follow basic guidelines
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Don't use deprecated funtions in your examples
7 participants