From d636252a20a31411a9c41766942792b89d74740f Mon Sep 17 00:00:00 2001 From: alkemper Date: Wed, 30 Apr 2025 16:49:02 -0700 Subject: [PATCH 1/5] remove references to prev settings doc --- docs/cpp/configure-intellisense-crosscompilation.md | 2 +- docs/cpp/configure-intellisense.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/cpp/configure-intellisense-crosscompilation.md b/docs/cpp/configure-intellisense-crosscompilation.md index c2ec907e04..b84783ca67 100644 --- a/docs/cpp/configure-intellisense-crosscompilation.md +++ b/docs/cpp/configure-intellisense-crosscompilation.md @@ -75,5 +75,5 @@ Given the settings above, your `c_cpp_configuration.json` file will look somethi - For more information about IntelliSense configuration, see [Customizing default settings](/docs/cpp/customize-default-settings-cpp.md). - If you have trouble configuring the settings, please start a discussion at [GitHub discussions](https://github.com/microsoft/vscode-cpptools/discussions), or if you find an issue that needs to be fixed, file an issue at [GitHub issues](https://github.com/microsoft/vscode-cpptools/issues). -- Explore the [c_cpp_properties schema](/docs/cpp/c-cpp-properties-schema-reference.md). +- Explore the [c_cpp_properties schema](/docs/cpp/customize-cpp-settings.md). - Review the [Overview of the C++ extension](/docs/languages/cpp.md). diff --git a/docs/cpp/configure-intellisense.md b/docs/cpp/configure-intellisense.md index 4d7bc410bb..b1f8c388ed 100644 --- a/docs/cpp/configure-intellisense.md +++ b/docs/cpp/configure-intellisense.md @@ -25,7 +25,7 @@ If you don't have IntelliSense configured, the C/C++ extension shows a yellow in To configure, select the status bar indicator, which brings up the [configuration Quick Pick](#option-1-select-a-configuration-option-through-the-configuration-quick-pick). The Quick Pick can help you select or install a C/C++ compiler. -If you do not see a status bar indicator, you can also check your project's `c_cpp_properties.json` file. This file stores all of your IntelliSense configuration settings. Navigate to this file by selecting **C/C++: Edit Configurations (UI)** from the Command Palette (`kb(workbench.action.showCommands)`). Check the `IntelliSense mode` to find your configuration. To learn more about the `c_cpp_properties.json` file, you can review the [schema reference](/docs/cpp/c-cpp-properties-schema-reference.md). +If you do not see a status bar indicator, you can also check your project's `c_cpp_properties.json` file. This file stores all of your IntelliSense configuration settings. Navigate to this file by selecting **C/C++: Edit Configurations (UI)** from the Command Palette (`kb(workbench.action.showCommands)`). Check the `IntelliSense mode` to find your configuration. To learn more about the `c_cpp_properties.json` file, you can review the [schema reference](/docs/cpp/customize-cpp-settings.md). ![Command Palette filtered on C/C++ Edit Configurations command](images/intellisense/edit-configurations-ui.png) @@ -59,7 +59,7 @@ You can edit the `c_cpp_properties.json` file directly to customize your configu Use the `compilerPath` variable to add a compiler. This variable is the full path of the compiler you're using to build your project. For example, when using the default install path for GCC on Linux, the compiler path is `/usr/bin/gcc`. -For more information about the `c_cpp_properties.json` file, review the [schema reference](/docs/cpp/c-cpp-properties-schema-reference.md). +For more information about the `c_cpp_properties.json` file, review the [schema reference](/docs/cpp/customize-cpp-settings.md). Select the sample below based on your operating system for a `c_cpp_configuration.json` file: @@ -203,5 +203,5 @@ You can select the pin icon on the right of any item in the language status bar * For more information about IntelliSense configuration, see [Customizing default settings](/docs/cpp/customize-default-settings-cpp.md). * If you have trouble configuring the settings, please start a discussion at [GitHub discussions](https://github.com/microsoft/vscode-cpptools/discussions), or if you find an issue that needs to be fixed, file an issue at [GitHub issues](https://github.com/microsoft/vscode-cpptools/issues). -* Explore the [c_cpp_properties schema](/docs/cpp/c-cpp-properties-schema-reference.md). +* Explore the [c_cpp_properties schema](/docs/cpp/customize-cpp-settings.md). * Review the [Overview of the C++ extension](/docs/languages/cpp.md). From e3a6745520aff00a942f4766747a9c09917ac56a Mon Sep 17 00:00:00 2001 From: alkemper Date: Wed, 30 Apr 2025 16:51:09 -0700 Subject: [PATCH 2/5] update toc with nested changes --- docs/toc.json | 38 ++++++++++++++++++++++++++++---------- 1 file changed, 28 insertions(+), 10 deletions(-) diff --git a/docs/toc.json b/docs/toc.json index fc74f1ae9e..d3e43fe213 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -269,17 +269,35 @@ "area": "cpp", "topics": [ ["Intro Videos", "/docs/cpp/introvideos-cpp"], - ["GCC on Linux", "/docs/cpp/config-linux"], - ["GCC on Windows", "/docs/cpp/config-mingw"], - ["GCC on Windows Subsystem for Linux", "/docs/cpp/config-wsl"], - ["Clang on macOS", "/docs/cpp/config-clang-mac"], - ["Microsoft C++ on Windows", "/docs/cpp/config-msvc"], - ["Build with CMake", "/docs/cpp/build-with-cmake"], - ["CMake Tools on Linux", "/docs/cpp/cmake-linux"], - ["CMake Quick Start", "/docs/cpp/cmake-quickstart"], + ["", "", { + "name": "Getting Started", + "area": "cpp", + "topics": [ + ["GCC on Linux", "/docs/cpp/config-linux"], + ["GCC on Windows", "/docs/cpp/config-mingw"], + ["GCC on Windows Subsystem for Linux", "/docs/cpp/config-wsl"], + ["Clang on macOS", "/docs/cpp/config-clang-mac"], + ["Microsoft C++ on Windows", "/docs/cpp/config-msvc"] + ] + }], + ["", "", { + "name": "Build with CMake", + "area": "cpp", + "topics": [ + ["CMake Quick Start", "/docs/cpp/cmake-quickstart"], + ["Build with CMake", "/docs/cpp/build-with-cmake"], + ["CMake Tools on Linux", "/docs/cpp/cmake-linux"] + ] + }], ["Editing and Navigating", "/docs/cpp/cpp-ide"], - ["Debugging", "/docs/cpp/cpp-debug"], - ["Configure Debugging", "/docs/cpp/launch-json-reference"], + ["", "", { + "name": "Debugging", + "area": "cpp", + "topics": [ + ["Debugging", "/docs/cpp/cpp-debug"], + ["Configure Debugging", "/docs/cpp/launch-json-reference"], + ] + }], ["Refactoring", "/docs/cpp/cpp-refactoring"], ["Settings", "/docs/cpp/customize-default-settings-cpp"], ["Configure IntelliSense", "/docs/cpp/configure-intellisense"], From 5cc451b1826d6689dfc0de9d9fe4ef94522bd08e Mon Sep 17 00:00:00 2001 From: alkemper Date: Thu, 1 May 2025 16:07:47 -0700 Subject: [PATCH 3/5] add new folders for docs and update paths. Files are not deleted, just moved --- .../build-with-cmake.md | 0 .../cmake-quickstart.md | 0 docs/cpp/{ => Debugging}/cpp-debug.md | 0 .../{ => Debugging}/launch-json-reference.md | 0 .../{ => Getting Started}/config-clang-mac.md | 0 .../cpp/{ => Getting Started}/config-linux.md | 0 .../cpp/{ => Getting Started}/config-mingw.md | 0 docs/cpp/{ => Getting Started}/config-msvc.md | 0 docs/cpp/{ => Getting Started}/config-wsl.md | 0 docs/cpp/customize-default-settings-cpp.md | 2 +- docs/toc.json | 26 +++++++++---------- 11 files changed, 14 insertions(+), 14 deletions(-) rename docs/cpp/{ => Build with CMake}/build-with-cmake.md (100%) rename docs/cpp/{ => Build with CMake}/cmake-quickstart.md (100%) rename docs/cpp/{ => Debugging}/cpp-debug.md (100%) rename docs/cpp/{ => Debugging}/launch-json-reference.md (100%) rename docs/cpp/{ => Getting Started}/config-clang-mac.md (100%) rename docs/cpp/{ => Getting Started}/config-linux.md (100%) rename docs/cpp/{ => Getting Started}/config-mingw.md (100%) rename docs/cpp/{ => Getting Started}/config-msvc.md (100%) rename docs/cpp/{ => Getting Started}/config-wsl.md (100%) diff --git a/docs/cpp/build-with-cmake.md b/docs/cpp/Build with CMake/build-with-cmake.md similarity index 100% rename from docs/cpp/build-with-cmake.md rename to docs/cpp/Build with CMake/build-with-cmake.md diff --git a/docs/cpp/cmake-quickstart.md b/docs/cpp/Build with CMake/cmake-quickstart.md similarity index 100% rename from docs/cpp/cmake-quickstart.md rename to docs/cpp/Build with CMake/cmake-quickstart.md diff --git a/docs/cpp/cpp-debug.md b/docs/cpp/Debugging/cpp-debug.md similarity index 100% rename from docs/cpp/cpp-debug.md rename to docs/cpp/Debugging/cpp-debug.md diff --git a/docs/cpp/launch-json-reference.md b/docs/cpp/Debugging/launch-json-reference.md similarity index 100% rename from docs/cpp/launch-json-reference.md rename to docs/cpp/Debugging/launch-json-reference.md diff --git a/docs/cpp/config-clang-mac.md b/docs/cpp/Getting Started/config-clang-mac.md similarity index 100% rename from docs/cpp/config-clang-mac.md rename to docs/cpp/Getting Started/config-clang-mac.md diff --git a/docs/cpp/config-linux.md b/docs/cpp/Getting Started/config-linux.md similarity index 100% rename from docs/cpp/config-linux.md rename to docs/cpp/Getting Started/config-linux.md diff --git a/docs/cpp/config-mingw.md b/docs/cpp/Getting Started/config-mingw.md similarity index 100% rename from docs/cpp/config-mingw.md rename to docs/cpp/Getting Started/config-mingw.md diff --git a/docs/cpp/config-msvc.md b/docs/cpp/Getting Started/config-msvc.md similarity index 100% rename from docs/cpp/config-msvc.md rename to docs/cpp/Getting Started/config-msvc.md diff --git a/docs/cpp/config-wsl.md b/docs/cpp/Getting Started/config-wsl.md similarity index 100% rename from docs/cpp/config-wsl.md rename to docs/cpp/Getting Started/config-wsl.md diff --git a/docs/cpp/customize-default-settings-cpp.md b/docs/cpp/customize-default-settings-cpp.md index 84594e7338..f447ca2dfa 100644 --- a/docs/cpp/customize-default-settings-cpp.md +++ b/docs/cpp/customize-default-settings-cpp.md @@ -87,7 +87,7 @@ Note that for the properties that accept string[], the syntax proposed above all If a property is missing from `c_cpp_properties.json`, the extension will use the value in the VS Code setting. If a developer assigns values to all of the settings that apply for a given folder, then `c_cpp_properties.json` could be removed from the .vscode folder as it will no longer be needed. -For in-depth information about the c_cpp_properties.json settings file, See [c_cpp_properties.json reference](/docs/cpp/c-cpp-properties-schema-reference.md). +For in-depth information about the c_cpp_properties.json settings file, See [c_cpp_properties.json reference](/docs/cpp/customize-cpp-settings.md). ### System includes diff --git a/docs/toc.json b/docs/toc.json index d3e43fe213..24c94a29f9 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -271,31 +271,31 @@ ["Intro Videos", "/docs/cpp/introvideos-cpp"], ["", "", { "name": "Getting Started", - "area": "cpp", + "area": "gettingstarted", "topics": [ - ["GCC on Linux", "/docs/cpp/config-linux"], - ["GCC on Windows", "/docs/cpp/config-mingw"], - ["GCC on Windows Subsystem for Linux", "/docs/cpp/config-wsl"], - ["Clang on macOS", "/docs/cpp/config-clang-mac"], - ["Microsoft C++ on Windows", "/docs/cpp/config-msvc"] + ["GCC on Linux", "/docs/cpp/gettingstarted/config-linux"], + ["GCC on Windows", "/docs/cpp/gettingstarted/config-mingw"], + ["GCC on Windows Subsystem for Linux", "/docs/cpp/gettingstarted/config-wsl"], + ["Clang on macOS", "/docs/cpp/gettingstarted/config-clang-mac"], + ["Microsoft C++ on Windows", "/docs/cpp/gettingstarted/config-msvc"] ] }], ["", "", { "name": "Build with CMake", - "area": "cpp", + "area": "cmake", "topics": [ - ["CMake Quick Start", "/docs/cpp/cmake-quickstart"], - ["Build with CMake", "/docs/cpp/build-with-cmake"], - ["CMake Tools on Linux", "/docs/cpp/cmake-linux"] + ["CMake Quick Start", "/docs/cpp/cmake/cmake-quickstart"], + ["Build with CMake", "/docs/cpp/cmake/build-with-cmake"], + ["CMake Tools on Linux", "/docs/cmake/cpp/cmake-linux"] ] }], ["Editing and Navigating", "/docs/cpp/cpp-ide"], ["", "", { "name": "Debugging", - "area": "cpp", + "area": "debugging", "topics": [ - ["Debugging", "/docs/cpp/cpp-debug"], - ["Configure Debugging", "/docs/cpp/launch-json-reference"], + ["Debugging", "/docs/cpp/debugging/cpp-debug"], + ["Configure Debugging", "/docs/cpp/debugging/launch-json-reference"], ] }], ["Refactoring", "/docs/cpp/cpp-refactoring"], From 0919bd71688eb7b007e77299b7eb3fe7946a43d0 Mon Sep 17 00:00:00 2001 From: alkemper Date: Fri, 2 May 2025 14:13:21 -0700 Subject: [PATCH 4/5] update area names --- docs/toc.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/toc.json b/docs/toc.json index 24c94a29f9..0f32a15382 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -271,7 +271,7 @@ ["Intro Videos", "/docs/cpp/introvideos-cpp"], ["", "", { "name": "Getting Started", - "area": "gettingstarted", + "area": "cpp/gettingstarted", "topics": [ ["GCC on Linux", "/docs/cpp/gettingstarted/config-linux"], ["GCC on Windows", "/docs/cpp/gettingstarted/config-mingw"], @@ -282,7 +282,7 @@ }], ["", "", { "name": "Build with CMake", - "area": "cmake", + "area": "cpp/cmake", "topics": [ ["CMake Quick Start", "/docs/cpp/cmake/cmake-quickstart"], ["Build with CMake", "/docs/cpp/cmake/build-with-cmake"], @@ -292,7 +292,7 @@ ["Editing and Navigating", "/docs/cpp/cpp-ide"], ["", "", { "name": "Debugging", - "area": "debugging", + "area": "cpp/debugging", "topics": [ ["Debugging", "/docs/cpp/debugging/cpp-debug"], ["Configure Debugging", "/docs/cpp/debugging/launch-json-reference"], From d2bfce4aa41ceeee680ce4001d725dcb5c8a2faa Mon Sep 17 00:00:00 2001 From: alkemper Date: Tue, 6 May 2025 09:38:37 -0700 Subject: [PATCH 5/5] update folder naming --- docs/cpp/{Build with CMake => cmake}/build-with-cmake.md | 0 docs/cpp/{Build with CMake => cmake}/cmake-quickstart.md | 0 docs/cpp/{Getting Started => gettingstarted}/config-clang-mac.md | 0 docs/cpp/{Getting Started => gettingstarted}/config-linux.md | 0 docs/cpp/{Getting Started => gettingstarted}/config-mingw.md | 0 docs/cpp/{Getting Started => gettingstarted}/config-msvc.md | 0 docs/cpp/{Getting Started => gettingstarted}/config-wsl.md | 0 7 files changed, 0 insertions(+), 0 deletions(-) rename docs/cpp/{Build with CMake => cmake}/build-with-cmake.md (100%) rename docs/cpp/{Build with CMake => cmake}/cmake-quickstart.md (100%) rename docs/cpp/{Getting Started => gettingstarted}/config-clang-mac.md (100%) rename docs/cpp/{Getting Started => gettingstarted}/config-linux.md (100%) rename docs/cpp/{Getting Started => gettingstarted}/config-mingw.md (100%) rename docs/cpp/{Getting Started => gettingstarted}/config-msvc.md (100%) rename docs/cpp/{Getting Started => gettingstarted}/config-wsl.md (100%) diff --git a/docs/cpp/Build with CMake/build-with-cmake.md b/docs/cpp/cmake/build-with-cmake.md similarity index 100% rename from docs/cpp/Build with CMake/build-with-cmake.md rename to docs/cpp/cmake/build-with-cmake.md diff --git a/docs/cpp/Build with CMake/cmake-quickstart.md b/docs/cpp/cmake/cmake-quickstart.md similarity index 100% rename from docs/cpp/Build with CMake/cmake-quickstart.md rename to docs/cpp/cmake/cmake-quickstart.md diff --git a/docs/cpp/Getting Started/config-clang-mac.md b/docs/cpp/gettingstarted/config-clang-mac.md similarity index 100% rename from docs/cpp/Getting Started/config-clang-mac.md rename to docs/cpp/gettingstarted/config-clang-mac.md diff --git a/docs/cpp/Getting Started/config-linux.md b/docs/cpp/gettingstarted/config-linux.md similarity index 100% rename from docs/cpp/Getting Started/config-linux.md rename to docs/cpp/gettingstarted/config-linux.md diff --git a/docs/cpp/Getting Started/config-mingw.md b/docs/cpp/gettingstarted/config-mingw.md similarity index 100% rename from docs/cpp/Getting Started/config-mingw.md rename to docs/cpp/gettingstarted/config-mingw.md diff --git a/docs/cpp/Getting Started/config-msvc.md b/docs/cpp/gettingstarted/config-msvc.md similarity index 100% rename from docs/cpp/Getting Started/config-msvc.md rename to docs/cpp/gettingstarted/config-msvc.md diff --git a/docs/cpp/Getting Started/config-wsl.md b/docs/cpp/gettingstarted/config-wsl.md similarity index 100% rename from docs/cpp/Getting Started/config-wsl.md rename to docs/cpp/gettingstarted/config-wsl.md