From d938359602e7e02ffd10950611c34dc1576b3281 Mon Sep 17 00:00:00 2001 From: nicole mazzuca Date: Wed, 2 Dec 2020 11:21:22 -0800 Subject: [PATCH] [docs] fix pwsh sorting (#14914) --- docs/maintainers/portfile-functions.md | 108 ++++++++++++------------- docs/regenerate.ps1 | 21 +++-- 2 files changed, 70 insertions(+), 59 deletions(-) diff --git a/docs/maintainers/portfile-functions.md b/docs/maintainers/portfile-functions.md index 56e42bbd80..e94d47e190 100644 --- a/docs/maintainers/portfile-functions.md +++ b/docs/maintainers/portfile-functions.md @@ -1,57 +1,57 @@ -# Portfile helper functions -- [execute\_process](execute_process.md) -- [vcpkg\_acquire\_msys](vcpkg_acquire_msys.md) -- [vcpkg\_add\_to\_path](vcpkg_add_to_path.md) -- [vcpkg\_apply\_patches](vcpkg_apply_patches.md) -- [vcpkg\_build\_cmake](vcpkg_build_cmake.md) -- [vcpkg\_build\_gn](vcpkg_build_gn.md) -- [vcpkg\_build\_make](vcpkg_build_make.md) -- [vcpkg\_build\_msbuild](vcpkg_build_msbuild.md) -- [vcpkg\_build\_ninja](vcpkg_build_ninja.md) -- [vcpkg\_build\_nmake](vcpkg_build_nmake.md) -- [vcpkg\_build\_qmake](vcpkg_build_qmake.md) -- [vcpkg\_buildpath\_length\_warning](vcpkg_buildpath_length_warning.md) -- [vcpkg\_check\_features](vcpkg_check_features.md) -- [vcpkg\_check\_linkage](vcpkg_check_linkage.md) -- [vcpkg\_clean\_executables\_in\_bin](vcpkg_clean_executables_in_bin.md) -- [vcpkg\_clean\_msbuild](vcpkg_clean_msbuild.md) -- [vcpkg\_common\_definitions](vcpkg_common_definitions.md) -- [vcpkg\_configure\_cmake](vcpkg_configure_cmake.md) -- [vcpkg\_configure\_gn](vcpkg_configure_gn.md) -- [vcpkg\_configure\_make](vcpkg_configure_make.md) -- [vcpkg\_configure\_meson](vcpkg_configure_meson.md) -- [vcpkg\_configure\_qmake](vcpkg_configure_qmake.md) -- [vcpkg\_copy\_pdbs](vcpkg_copy_pdbs.md) -- [vcpkg\_copy\_tool\_dependencies](vcpkg_copy_tool_dependencies.md) -- [vcpkg\_copy\_tools](vcpkg_copy_tools.md) -- [vcpkg\_download\_distfile](vcpkg_download_distfile.md) -- [vcpkg\_execute\_build\_process](vcpkg_execute_build_process.md) -- [vcpkg\_execute\_in\_download\_mode](vcpkg_execute_in_download_mode.md) -- [vcpkg\_execute\_required\_process](vcpkg_execute_required_process.md) -- [vcpkg\_execute\_required\_process\_repeat](vcpkg_execute_required_process_repeat.md) -- [vcpkg\_extract\_source\_archive](vcpkg_extract_source_archive.md) -- [vcpkg\_extract\_source\_archive\_ex](vcpkg_extract_source_archive_ex.md) -- [vcpkg\_fail\_port\_install](vcpkg_fail_port_install.md) -- [vcpkg\_find\_acquire\_program](vcpkg_find_acquire_program.md) -- [vcpkg\_find\_fortran](vcpkg_find_fortran.md) -- [vcpkg\_fixup\_cmake\_targets](vcpkg_fixup_cmake_targets.md) -- [vcpkg\_fixup\_pkgconfig](vcpkg_fixup_pkgconfig.md) -- [vcpkg\_from\_bitbucket](vcpkg_from_bitbucket.md) -- [vcpkg\_from\_git](vcpkg_from_git.md) -- [vcpkg\_from\_github](vcpkg_from_github.md) -- [vcpkg\_from\_gitlab](vcpkg_from_gitlab.md) -- [vcpkg\_from\_sourceforge](vcpkg_from_sourceforge.md) -- [vcpkg\_get\_program\_files\_platform\_bitness](vcpkg_get_program_files_platform_bitness.md) -- [vcpkg\_get\_windows\_sdk](vcpkg_get_windows_sdk.md) -- [vcpkg\_install\_cmake](vcpkg_install_cmake.md) -- [vcpkg\_install\_gn](vcpkg_install_gn.md) -- [vcpkg\_install\_make](vcpkg_install_make.md) -- [vcpkg\_install\_meson](vcpkg_install_meson.md) -- [vcpkg\_install\_msbuild](vcpkg_install_msbuild.md) -- [vcpkg\_install\_nmake](vcpkg_install_nmake.md) -- [vcpkg\_install\_qmake](vcpkg_install_qmake.md) -- [vcpkg\_internal\_get\_cmake\_vars](vcpkg_internal_get_cmake_vars.md) -- [vcpkg\_prettify\_command](vcpkg_prettify_command.md) +# Portfile helper functions +- [execute\_process](execute_process.md) +- [vcpkg\_acquire\_msys](vcpkg_acquire_msys.md) +- [vcpkg\_add\_to\_path](vcpkg_add_to_path.md) +- [vcpkg\_apply\_patches](vcpkg_apply_patches.md) +- [vcpkg\_build\_cmake](vcpkg_build_cmake.md) +- [vcpkg\_build\_gn](vcpkg_build_gn.md) +- [vcpkg\_build\_make](vcpkg_build_make.md) +- [vcpkg\_build\_msbuild](vcpkg_build_msbuild.md) +- [vcpkg\_build\_ninja](vcpkg_build_ninja.md) +- [vcpkg\_build\_nmake](vcpkg_build_nmake.md) +- [vcpkg\_build\_qmake](vcpkg_build_qmake.md) +- [vcpkg\_buildpath\_length\_warning](vcpkg_buildpath_length_warning.md) +- [vcpkg\_check\_features](vcpkg_check_features.md) +- [vcpkg\_check\_linkage](vcpkg_check_linkage.md) +- [vcpkg\_clean\_executables\_in\_bin](vcpkg_clean_executables_in_bin.md) +- [vcpkg\_clean\_msbuild](vcpkg_clean_msbuild.md) +- [vcpkg\_common\_definitions](vcpkg_common_definitions.md) +- [vcpkg\_configure\_cmake](vcpkg_configure_cmake.md) +- [vcpkg\_configure\_gn](vcpkg_configure_gn.md) +- [vcpkg\_configure\_make](vcpkg_configure_make.md) +- [vcpkg\_configure\_meson](vcpkg_configure_meson.md) +- [vcpkg\_configure\_qmake](vcpkg_configure_qmake.md) +- [vcpkg\_copy\_pdbs](vcpkg_copy_pdbs.md) +- [vcpkg\_copy\_tool\_dependencies](vcpkg_copy_tool_dependencies.md) +- [vcpkg\_copy\_tools](vcpkg_copy_tools.md) +- [vcpkg\_download\_distfile](vcpkg_download_distfile.md) +- [vcpkg\_execute\_build\_process](vcpkg_execute_build_process.md) +- [vcpkg\_execute\_in\_download\_mode](vcpkg_execute_in_download_mode.md) +- [vcpkg\_execute\_required\_process](vcpkg_execute_required_process.md) +- [vcpkg\_execute\_required\_process\_repeat](vcpkg_execute_required_process_repeat.md) +- [vcpkg\_extract\_source\_archive](vcpkg_extract_source_archive.md) +- [vcpkg\_extract\_source\_archive\_ex](vcpkg_extract_source_archive_ex.md) +- [vcpkg\_fail\_port\_install](vcpkg_fail_port_install.md) +- [vcpkg\_find\_acquire\_program](vcpkg_find_acquire_program.md) +- [vcpkg\_find\_fortran](vcpkg_find_fortran.md) +- [vcpkg\_fixup\_cmake\_targets](vcpkg_fixup_cmake_targets.md) +- [vcpkg\_fixup\_pkgconfig](vcpkg_fixup_pkgconfig.md) +- [vcpkg\_from\_bitbucket](vcpkg_from_bitbucket.md) +- [vcpkg\_from\_git](vcpkg_from_git.md) +- [vcpkg\_from\_github](vcpkg_from_github.md) +- [vcpkg\_from\_gitlab](vcpkg_from_gitlab.md) +- [vcpkg\_from\_sourceforge](vcpkg_from_sourceforge.md) +- [vcpkg\_get\_program\_files\_platform\_bitness](vcpkg_get_program_files_platform_bitness.md) +- [vcpkg\_get\_windows\_sdk](vcpkg_get_windows_sdk.md) +- [vcpkg\_install\_cmake](vcpkg_install_cmake.md) +- [vcpkg\_install\_gn](vcpkg_install_gn.md) +- [vcpkg\_install\_make](vcpkg_install_make.md) +- [vcpkg\_install\_meson](vcpkg_install_meson.md) +- [vcpkg\_install\_msbuild](vcpkg_install_msbuild.md) +- [vcpkg\_install\_nmake](vcpkg_install_nmake.md) +- [vcpkg\_install\_qmake](vcpkg_install_qmake.md) +- [vcpkg\_internal\_get\_cmake\_vars](vcpkg_internal_get_cmake_vars.md) +- [vcpkg\_prettify\_command](vcpkg_prettify_command.md) - [vcpkg\_replace\_string](vcpkg_replace_string.md) diff --git a/docs/regenerate.ps1 b/docs/regenerate.ps1 index c984ad77b4..3593746adb 100644 --- a/docs/regenerate.ps1 +++ b/docs/regenerate.ps1 @@ -13,9 +13,7 @@ if (-not (Test-Path "$VcpkgRoot/.vcpkg-root")) { throw "Invalid vcpkg instance, did you forget -VcpkgRoot?" } -Set-Content ` - -Path "$PSScriptRoot/maintainers/portfile-functions.md" ` - -Value "`n`n# Portfile helper functions" +$tableOfContents = @() Get-ChildItem "$VcpkgRoot/scripts/cmake" -Filter '*.cmake' | ForEach-Object { $filename = $_ @@ -72,10 +70,23 @@ Get-ChildItem "$VcpkgRoot/scripts/cmake" -Filter '*.cmake' | ForEach-Object { if ($contents) { Set-Content -Path "$PSScriptRoot/maintainers/$($filename.BaseName).md" -Value "$($contents -join "`n")`n`n## Source`n[scripts/cmake/$($filename.Name)](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/$($filename.Name))" - "- [$($filename.BaseName -replace "_","\_")]($($filename.BaseName).md)" ` - | Out-File -Enc Ascii -Append -FilePath "$PSScriptRoot/maintainers/portfile-functions.md" + + $tableOfContents += $filename.BaseName } elseif (-not $filename.Name.StartsWith("vcpkg_internal")) { # don't worry about undocumented internal functions Write-Warning "The cmake function in file $filename doesn't seem to have any documentation. Make sure the documentation comments are correctly written." } } + +$portfileFunctionsContent = @( + '', + '', + '# Portfile helper functions') + +$tableOfContents | Sort-Object -Culture '' | ForEach-Object { + $portfileFunctionsContent += "- [$($_ -replace '_','\_')]($_.md)" +} + +Set-Content ` + -Path "$PSScriptRoot/maintainers/portfile-functions.md" ` + -Value ($portfileFunctionsContent -join "`n")