From 0a4fef1f15d282c403e162d73c80f52905428c8d Mon Sep 17 00:00:00 2001 From: Hamir Mahal Date: Sun, 6 Feb 2022 12:52:10 -0800 Subject: [PATCH 1/7] clarify how to get binaries if F5 results in error --- Documentation/Building the Extension.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/Documentation/Building the Extension.md b/Documentation/Building the Extension.md index 64c5d9a37..32d59f97e 100644 --- a/Documentation/Building the Extension.md +++ b/Documentation/Building the Extension.md @@ -13,3 +13,12 @@ Prerequisite steps: * **(optional)** Set an environment variable `CPPTOOLS_DEV=1`. * This enables the local developer workflow when testing the debugger, copying dependencies from the **node_modules** folder. Testing the language server does not require this step. * Open the **Extension** folder in Visual Studio Code and press F5. This will launch a VS Code Extension Host window and activate the TypeScript debugger. You can set breakpoints on the extension source code and debug your scenario. + * If, after pressing F5, you see the following error in the `[Extension Development Host]` window, + > Unable to start the C/C++ language server. IntelliSense features will be disabled. Error: Missing binary at .../vscode-cpptools/Extension/bin/cpptools + * ... Then, you can follow the instructions in this [comment in a discussion about building this extension locally](https://github.com/microsoft/vscode-cpptools/discussions/8745#discussioncomment-2091563). + > get the 1.8.2 binaries from installing the extension and then copying the binaries + 1. To do this, install this extension from the Visual Studio Marketplace and find its location on your device. It might be in a directory like `\\wsl$\Ubuntu\home\hamir\.vscode-server\extensions\ms-vscode.cpptools-1.8.2`, for example. + 2. Next, go to the `bin/` directory of the aforementioned directory, and drag-and-drop, or copy-and-paste, `cpptools` and `cpptools-srv` from `...\extensions\ms-vscode.cpptools-1.8.2\bin\` to this repository's `Extension\bin\` directory on your local device, so that `.../vscode-cpptools/Extension/bin/cpptools` and `.../vscode-cpptools/Extension/bin/cpptools-srv` both exist in your workspace. + 3. The aforementioned warning should be gone, and Intellisense, which gives those squiggly red error lines, should now be present. + + * Feel free to use [the Discussions tab of this repository](https://github.com/microsoft/vscode-cpptools/discussions) if you have any further questions on building this extension locally. From 05400ba8a2ac80dfb7e3b4232edc3c3d08b01e7d Mon Sep 17 00:00:00 2001 From: Hamir Mahal Date: Sat, 12 Feb 2022 11:40:15 -0800 Subject: [PATCH 2/7] remove `...` from a couple paths This commit addresses https://github.com/microsoft/vscode-cpptools/pull/8788#discussion_r800937204. --- Documentation/Building the Extension.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Building the Extension.md b/Documentation/Building the Extension.md index 32d59f97e..6e127f5e8 100644 --- a/Documentation/Building the Extension.md +++ b/Documentation/Building the Extension.md @@ -18,7 +18,7 @@ Prerequisite steps: * ... Then, you can follow the instructions in this [comment in a discussion about building this extension locally](https://github.com/microsoft/vscode-cpptools/discussions/8745#discussioncomment-2091563). > get the 1.8.2 binaries from installing the extension and then copying the binaries 1. To do this, install this extension from the Visual Studio Marketplace and find its location on your device. It might be in a directory like `\\wsl$\Ubuntu\home\hamir\.vscode-server\extensions\ms-vscode.cpptools-1.8.2`, for example. - 2. Next, go to the `bin/` directory of the aforementioned directory, and drag-and-drop, or copy-and-paste, `cpptools` and `cpptools-srv` from `...\extensions\ms-vscode.cpptools-1.8.2\bin\` to this repository's `Extension\bin\` directory on your local device, so that `.../vscode-cpptools/Extension/bin/cpptools` and `.../vscode-cpptools/Extension/bin/cpptools-srv` both exist in your workspace. + 2. Next, go to the `bin/` directory of the aforementioned directory, and drag-and-drop, or copy-and-paste, `cpptools` and `cpptools-srv` from `\extensions\ms-vscode.cpptools-1.8.2\bin\` to this repository's `Extension\bin\` directory on your local device, so that `/vscode-cpptools/Extension/bin/cpptools` and `/vscode-cpptools/Extension/bin/cpptools-srv` both exist in your workspace. 3. The aforementioned warning should be gone, and Intellisense, which gives those squiggly red error lines, should now be present. * Feel free to use [the Discussions tab of this repository](https://github.com/microsoft/vscode-cpptools/discussions) if you have any further questions on building this extension locally. From 3d509a2d18340583589cdec10266f9971edd4e0f Mon Sep 17 00:00:00 2001 From: Hamir Mahal Date: Sat, 12 Feb 2022 11:43:42 -0800 Subject: [PATCH 3/7] replace `1.8.2` with `` This commit addresses https://github.com/microsoft/vscode-cpptools/pull/8788#discussion_r800938662. --- Documentation/Building the Extension.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/Building the Extension.md b/Documentation/Building the Extension.md index 6e127f5e8..e18c4b997 100644 --- a/Documentation/Building the Extension.md +++ b/Documentation/Building the Extension.md @@ -16,9 +16,9 @@ Prerequisite steps: * If, after pressing F5, you see the following error in the `[Extension Development Host]` window, > Unable to start the C/C++ language server. IntelliSense features will be disabled. Error: Missing binary at .../vscode-cpptools/Extension/bin/cpptools * ... Then, you can follow the instructions in this [comment in a discussion about building this extension locally](https://github.com/microsoft/vscode-cpptools/discussions/8745#discussioncomment-2091563). - > get the 1.8.2 binaries from installing the extension and then copying the binaries - 1. To do this, install this extension from the Visual Studio Marketplace and find its location on your device. It might be in a directory like `\\wsl$\Ubuntu\home\hamir\.vscode-server\extensions\ms-vscode.cpptools-1.8.2`, for example. - 2. Next, go to the `bin/` directory of the aforementioned directory, and drag-and-drop, or copy-and-paste, `cpptools` and `cpptools-srv` from `\extensions\ms-vscode.cpptools-1.8.2\bin\` to this repository's `Extension\bin\` directory on your local device, so that `/vscode-cpptools/Extension/bin/cpptools` and `/vscode-cpptools/Extension/bin/cpptools-srv` both exist in your workspace. + > get the binaries from installing the extension and then copying the binaries + 1. To do this, install this extension from the Visual Studio Marketplace and find its location on your device. It might be in a directory like `\\wsl$\Ubuntu\home\hamir\.vscode-server\extensions\ms-vscode.cpptools-`, for example. + 2. Next, go to the `bin/` directory of the aforementioned directory, and drag-and-drop, or copy-and-paste, `cpptools` and `cpptools-srv` from `\extensions\ms-vscode.cpptools-\bin\` to this repository's `Extension\bin\` directory on your local device, so that `/vscode-cpptools/Extension/bin/cpptools` and `/vscode-cpptools/Extension/bin/cpptools-srv` both exist in your workspace. 3. The aforementioned warning should be gone, and Intellisense, which gives those squiggly red error lines, should now be present. * Feel free to use [the Discussions tab of this repository](https://github.com/microsoft/vscode-cpptools/discussions) if you have any further questions on building this extension locally. From d4c4a102f7762a34700e6f93e5c529de05e28e0a Mon Sep 17 00:00:00 2001 From: Hamir Mahal Date: Sat, 12 Feb 2022 11:47:15 -0800 Subject: [PATCH 4/7] add a recommended fourth point This commit addresses https://github.com/microsoft/vscode-cpptools/pull/8788#discussion_r800942615. --- Documentation/Building the Extension.md | 1 + 1 file changed, 1 insertion(+) diff --git a/Documentation/Building the Extension.md b/Documentation/Building the Extension.md index e18c4b997..f4ecc8fdc 100644 --- a/Documentation/Building the Extension.md +++ b/Documentation/Building the Extension.md @@ -20,5 +20,6 @@ Prerequisite steps: 1. To do this, install this extension from the Visual Studio Marketplace and find its location on your device. It might be in a directory like `\\wsl$\Ubuntu\home\hamir\.vscode-server\extensions\ms-vscode.cpptools-`, for example. 2. Next, go to the `bin/` directory of the aforementioned directory, and drag-and-drop, or copy-and-paste, `cpptools` and `cpptools-srv` from `\extensions\ms-vscode.cpptools-\bin\` to this repository's `Extension\bin\` directory on your local device, so that `/vscode-cpptools/Extension/bin/cpptools` and `/vscode-cpptools/Extension/bin/cpptools-srv` both exist in your workspace. 3. The aforementioned warning should be gone, and Intellisense, which gives those squiggly red error lines, should now be present. + 4. The `insiders` branch has binaries compatible with the latest Pre-Release version of the extension, and the `release` branch has binaries compatible with the latest Release version, but the `main` branch may have TypeScript changes that are incompatible with the published binaries, in which case, you'll need to create a branch off the `insiders` or `release` branches." * Feel free to use [the Discussions tab of this repository](https://github.com/microsoft/vscode-cpptools/discussions) if you have any further questions on building this extension locally. From 888efa96850d9719c7f58e30fb2d3b88cd3d9314 Mon Sep 17 00:00:00 2001 From: Hamir Mahal Date: Sat, 12 Feb 2022 11:52:17 -0800 Subject: [PATCH 5/7] remove lines that are no longer needed This commit addresses https://github.com/microsoft/vscode-cpptools/pull/8788#discussion_r804083255. --- Documentation/Building the Extension.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/Documentation/Building the Extension.md b/Documentation/Building the Extension.md index f4ecc8fdc..67e0a8a2e 100644 --- a/Documentation/Building the Extension.md +++ b/Documentation/Building the Extension.md @@ -10,8 +10,6 @@ Prerequisite steps: * From a command line, run the following commands from the **Extension** folder in the root of the repository: * `yarn install` will install the dependencies needed to build the extension. * **(optional)** `yarn global add vsce` will install `vsce` globally to create a VSIX package that you can install. - * **(optional)** Set an environment variable `CPPTOOLS_DEV=1`. - * This enables the local developer workflow when testing the debugger, copying dependencies from the **node_modules** folder. Testing the language server does not require this step. * Open the **Extension** folder in Visual Studio Code and press F5. This will launch a VS Code Extension Host window and activate the TypeScript debugger. You can set breakpoints on the extension source code and debug your scenario. * If, after pressing F5, you see the following error in the `[Extension Development Host]` window, > Unable to start the C/C++ language server. IntelliSense features will be disabled. Error: Missing binary at .../vscode-cpptools/Extension/bin/cpptools From 86df44e3f3d9a253cb76d0a42976dce028a7935d Mon Sep 17 00:00:00 2001 From: Hamir Mahal Date: Tue, 15 Feb 2022 11:26:25 -0800 Subject: [PATCH 6/7] place `...` in appropriate places This commit addresses https://github.com/microsoft/vscode-cpptools/pull/8788#discussion_r806136131. --- Documentation/Building the Extension.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/Building the Extension.md b/Documentation/Building the Extension.md index 67e0a8a2e..283d52a26 100644 --- a/Documentation/Building the Extension.md +++ b/Documentation/Building the Extension.md @@ -13,10 +13,10 @@ Prerequisite steps: * Open the **Extension** folder in Visual Studio Code and press F5. This will launch a VS Code Extension Host window and activate the TypeScript debugger. You can set breakpoints on the extension source code and debug your scenario. * If, after pressing F5, you see the following error in the `[Extension Development Host]` window, > Unable to start the C/C++ language server. IntelliSense features will be disabled. Error: Missing binary at .../vscode-cpptools/Extension/bin/cpptools - * ... Then, you can follow the instructions in this [comment in a discussion about building this extension locally](https://github.com/microsoft/vscode-cpptools/discussions/8745#discussioncomment-2091563). + * Then, you can follow the instructions in this [comment in a discussion about building this extension locally](https://github.com/microsoft/vscode-cpptools/discussions/8745#discussioncomment-2091563). > get the binaries from installing the extension and then copying the binaries 1. To do this, install this extension from the Visual Studio Marketplace and find its location on your device. It might be in a directory like `\\wsl$\Ubuntu\home\hamir\.vscode-server\extensions\ms-vscode.cpptools-`, for example. - 2. Next, go to the `bin/` directory of the aforementioned directory, and drag-and-drop, or copy-and-paste, `cpptools` and `cpptools-srv` from `\extensions\ms-vscode.cpptools-\bin\` to this repository's `Extension\bin\` directory on your local device, so that `/vscode-cpptools/Extension/bin/cpptools` and `/vscode-cpptools/Extension/bin/cpptools-srv` both exist in your workspace. + 2. Next, go to the `bin/` directory of the aforementioned directory, and drag-and-drop, or copy-and-paste, `cpptools` and `cpptools-srv` from `...\extensions\ms-vscode.cpptools-\bin\` to this repository's `Extension\bin\` directory on your local device, so that `.../vscode-cpptools/Extension/bin/cpptools` and `.../vscode-cpptools/Extension/bin/cpptools-srv` both exist in your workspace. 3. The aforementioned warning should be gone, and Intellisense, which gives those squiggly red error lines, should now be present. 4. The `insiders` branch has binaries compatible with the latest Pre-Release version of the extension, and the `release` branch has binaries compatible with the latest Release version, but the `main` branch may have TypeScript changes that are incompatible with the published binaries, in which case, you'll need to create a branch off the `insiders` or `release` branches." From 27b1ace1ad0088e3b79f6b76e44275fcefaf56a5 Mon Sep 17 00:00:00 2001 From: Hamir Mahal Date: Tue, 15 Feb 2022 11:30:41 -0800 Subject: [PATCH 7/7] fix stray quotation mark `"` This commit addresses https://github.com/microsoft/vscode-cpptools/pull/8788#discussion_r806134843. --- Documentation/Building the Extension.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Building the Extension.md b/Documentation/Building the Extension.md index 283d52a26..86b43a4d7 100644 --- a/Documentation/Building the Extension.md +++ b/Documentation/Building the Extension.md @@ -18,6 +18,6 @@ Prerequisite steps: 1. To do this, install this extension from the Visual Studio Marketplace and find its location on your device. It might be in a directory like `\\wsl$\Ubuntu\home\hamir\.vscode-server\extensions\ms-vscode.cpptools-`, for example. 2. Next, go to the `bin/` directory of the aforementioned directory, and drag-and-drop, or copy-and-paste, `cpptools` and `cpptools-srv` from `...\extensions\ms-vscode.cpptools-\bin\` to this repository's `Extension\bin\` directory on your local device, so that `.../vscode-cpptools/Extension/bin/cpptools` and `.../vscode-cpptools/Extension/bin/cpptools-srv` both exist in your workspace. 3. The aforementioned warning should be gone, and Intellisense, which gives those squiggly red error lines, should now be present. - 4. The `insiders` branch has binaries compatible with the latest Pre-Release version of the extension, and the `release` branch has binaries compatible with the latest Release version, but the `main` branch may have TypeScript changes that are incompatible with the published binaries, in which case, you'll need to create a branch off the `insiders` or `release` branches." + 4. The `insiders` branch has binaries compatible with the latest Pre-Release version of the extension, and the `release` branch has binaries compatible with the latest Release version, but the `main` branch may have TypeScript changes that are incompatible with the published binaries, in which case, you'll need to create a branch off the `insiders` or `release` branches. * Feel free to use [the Discussions tab of this repository](https://github.com/microsoft/vscode-cpptools/discussions) if you have any further questions on building this extension locally.