From f5d97174ed81d4c297929e05d23f18920dacb938 Mon Sep 17 00:00:00 2001 From: Cy 'kkm' Katsnelson Date: Sun, 30 Jun 2024 05:53:50 -0700 Subject: [PATCH] Use relative intralinks; Point 'issues' to main GH repo * Replace intra-repo absolute URLs with relative ones. * Replace remaining pointers to `vector-of-bool` with `microsoft` in the URLs than must remain absolute. --- docs/cmake-options-configuration.md | 4 ++-- docs/cmake-presets.md | 2 +- docs/debug-launch.md | 2 +- docs/faq.md | 2 +- docs/troubleshoot.md | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/cmake-options-configuration.md b/docs/cmake-options-configuration.md index b0e0e1bba..3d8b195d5 100644 --- a/docs/cmake-options-configuration.md +++ b/docs/cmake-options-configuration.md @@ -142,8 +142,8 @@ The full level of options for the CMake status can be seen below: * `folder` is the active folder in your workspace. This is where the project is scoped to. * `configure` is associated with the CMake Configure action. It can only be found in the Project Status View and can't be seen in the status bar, hence no `statusBarVisibility` property value. * `configurePreset` is associated with the CMake Configure Preset. When selected, the user can modify their active CMake Configure Preset from the list detected in their CMakePresets.json and CMakeUserPresets.json (if found in project). -* `kit` is associated with the active kit selected (when CMake Presets aren't present). When selected, the user can modify their active kit. To learn more about kits, please see [our kit documentation](https://github.com/microsoft/vscode-cmake-tools/docs/kits.md). -* `variant` is associated with the active variant (when CMake Presets aren't present). When selected, the user can modify their active variant. Variant status does not show on the Project Status View, but will show in the status bar when set to `visible`. To learn more about variants, please see [our variant documentation](https://github.com/microsoft/vscode-cmake-tools/docs/variants.md). +* `kit` is associated with the active kit selected (when CMake Presets aren't present). When selected, the user can modify their active kit. To learn more about kits, please see [our kit documentation](kits.md). +* `variant` is associated with the active variant (when CMake Presets aren't present). When selected, the user can modify their active variant. Variant status does not show on the Project Status View, but will show in the status bar when set to `visible`. To learn more about variants, please see [our variant documentation](variants.md). * `build` is associated with the CMake Build action. It invokes a CMake build on your build target using your build preset or variant. * `buildPreset` is associated with your active CMake Build Preset. When selected, the user can modify their active CMake Build Preset from the list detected in their CMakePresets.json and CMakeUserPresets.json (if found in project). * `buildTarget` is associated with your active CMake Build Target. When selected, the user can specify their active Build Target. This will be the target invoked when the user presses the `Build` icon in the status bar (if not hidden) or runs `CMake: Build Target` from the Command Palette. diff --git a/docs/cmake-presets.md b/docs/cmake-presets.md index 3e645d4ff..153b9694e 100644 --- a/docs/cmake-presets.md +++ b/docs/cmake-presets.md @@ -218,7 +218,7 @@ If you're already using a CMake toolchain file and want to enable vcpkg integrat ## Substitute commands in `launch.json` and `settings.json` -CMake Tools supports command substitution for launch commands when `CMakePresets.json` integration is enabled. For more information, see [Command substitution](https://github.com/microsoft/vscode-cmake-tools/blob/main/docs/cmake-settings.md#command-substitution). +CMake Tools supports command substitution for launch commands when `CMakePresets.json` integration is enabled. For more information, see [Command substitution](cmake-settings.md#command-substitution). ## Ignored settings diff --git a/docs/debug-launch.md b/docs/debug-launch.md index 7bb7e1458..4a19c7da2 100644 --- a/docs/debug-launch.md +++ b/docs/debug-launch.md @@ -43,7 +43,7 @@ Start a debugging session on the active target by running the *CMake: Debug* com You can specify the working directory or command line arguments for debugging, or use another debugger than the one included with Microsoft's `vscode-ms-vscode.cpptools`, by creating a `launch.json` file. -You'll need to know the path to the executable binary, which may be difficult to know in advance. CMake Tools can help by using [command substitution](https://github.com/microsoft/vscode-cmake-tools/blob/main/docs/cmake-settings.md#command-substitution) in the `launch.json` file. This is already used by things like process selection when attaching to a running process. It works by specifying a command-based substitution in the appropriate field of `launch.json`. +You'll need to know the path to the executable binary, which may be difficult to know in advance. CMake Tools can help by using [command substitution](cmake-settings.md#command-substitution) in the `launch.json` file. This is already used by things like process selection when attaching to a running process. It works by specifying a command-based substitution in the appropriate field of `launch.json`. Here are minimal examples of a `launch.json` file that uses `cmake.launchTargetPath` and `cmake.getLaunchTargetDirectory` to start a debugger on the active launch target: diff --git a/docs/faq.md b/docs/faq.md index 3dc8fb3e8..bcf723234 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -6,7 +6,7 @@ Please visit [the end-user support chat](https://gitter.im/vscode-cmake-tools/su Also look in the [Troubleshooting guide](troubleshoot.md). -Check the [CMake Tools issue tracker](https://github.com/vector-of-bool/vscode-cmake-tools/issues) and [What's New](https://github.com/microsoft/vscode-cmake-tools/blob/main/CHANGELOG.md) to see if your issue is already known/solved before submitting a question or bug report. Feel free to [Open a Github issue](https://github.com/microsoft/vscode-cmake-tools/issues) if your problem hasn't been reported. +Check the [CMake Tools issue tracker](https://github.com/microsoft/vscode-cmake-tools/issues) and [What's New](../CHANGELOG.md) to see if your issue is already known/solved before submitting a question or bug report. Feel free to [Open a Github issue](https://github.com/microsoft/vscode-cmake-tools/issues) if your problem hasn't been reported. Explore the [CMake Tools documentation](README.md) diff --git a/docs/troubleshoot.md b/docs/troubleshoot.md index bf25a0f8b..8f979528c 100644 --- a/docs/troubleshoot.md +++ b/docs/troubleshoot.md @@ -40,6 +40,6 @@ This file is user-local, not workspace-local. This file includes all log entries ## Get help -Check the [CMake Tools issue tracker](https://github.com/vector-of-bool/vscode-cmake-tools/issues) and [What's New](https://github.com/microsoft/vscode-cmake-tools/blob/main/CHANGELOG.md) to see if your issue is already known/solved before submitting a question or bug report. Feel free to open an issue if your problem hasn't been reported. +Check the [CMake Tools issue tracker](https://github.com/microsoft/vscode-cmake-tools/issues) and [What's New](../CHANGELOG.md) to see if your issue is already known/solved before submitting a question or bug report. Feel free to open an issue if your problem hasn't been reported. Please visit [the support chat](https://gitter.im/vscode-cmake-tools/support). This is a community chat. Microsoft does not monitor it. \ No newline at end of file