Skip to content

cleanup vscode references #138

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

cleanup vscode references #138

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# CDT GDB Debug Adapter Extension for Visual Studio Code
# CDT GDB Debug Adapter Extension for vscode

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this should remain "Visual Studio Code" (first time usage in this document).

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Possibly... note that by doing so, you use a Microsoft registered trademark (both the long and the short "VS Code" are) for something that is not directly invoked with that binary distribution. And of course when doing so the trademark's owner has something to say about how you may use it (all the icons and names stuff in your referenced doc is about that).

From the vscode repo's README:

Visual Studio Code is a distribution of the Code - OSS [vscode] repository with Microsoft-specific customizations released under a traditional Microsoft product license.

From their FAQ they link to microsoft/vscode#60 (comment) and make an extra point of https://code.visualstudio.com/docs/supporting/faq#_what-does-built-on-open-source-mean

In my view there are three options:

  • go the full MS way using their trademark all over the place (I personally dislike doing that whenever the parts referenced have nothing to do with the trademark
  • don't use that at all - because that README will mostly be shown in the editors themselves (extension view), then in the marketplaces - so you are "in" there already, no need to reference it (for GitHub and other places you can additionally talks about "for editors base on vscode including Visual Studio Code" (or however you like it) in the project's description (note, instead of the current "CDT GDB Visual Studio Code Extension" MS seems to want you to say "CDT GDB extension for Visual Studio Code", if you want to reference the trademark directly)
  • use the name of the tool that all is based on, which is named "Code - OSS" (until it is re-branded, which is the case for nearly all binary distributions as well as in installations like GitPod) or "vscode"

This is a Visual Studio Code extension that supports debugging using gdb and any other debugger that supports the MI protocol. It is built by the experts that provide the gdb support in the Eclipse C/C++ IDE (CDT).
This is an extension for vscode that supports debugging using gdb and any other debugger that supports the MI protocol. It is built by the experts that provide the gdb support in the Eclipse C/C++ IDE (CDT).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should probably say VS Code instead.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... if you want the trademark name there

This extension provides a number of features that integrate into the Visual Studio Code debug environment. This includes launch types, support for the standard debug views as well as a custom viewer for memory browsing.
This extension provides a number of features that integrate into the vscode debug environment. This includes launch types, support for the standard debug views as well as a custom viewer for memory browsing.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above: VS Code

## Prerequisites

Expand All @@ -12,7 +12,7 @@ External tools are expected to be present on your system depending on the intend

## Launch Configurations

The Visual Studio Debug Extension for GDB contributes two debugger types:
This extension contributes two debugger types:
* `gdb`: Support for **Local GDB Debug**. Launch or attach to an already running application locally on your host machine using GDB.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 , ok. Probably overdid it here a little.

* `gdbtarget`: Support for **Remote GDB Debug**. Launch or attach to an already running remote GDB server using GDB.

Expand Down Expand Up @@ -105,7 +105,7 @@ Settings related to displaying UART output in the debug console. This object can

## Memory Browser

The extension comes with a Memory Browser window. However, we have plans to deprecate and remove the window in favour of the Eclipse CDT Cloud [Memory Inspector](https://github.com/eclipse-cdt-cloud/vscode-memory-inspector) extension for Visual Studio Code which is available from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=eclipse-cdt.memory-inspector) and the [Open VSX Registry](https://open-vsx.org/extension/eclipse-cdt/memory-inspector).
The extension comes with a Memory Browser window. However, we have plans to deprecate and remove the window in favour of the Eclipse CDT Cloud [Memory Inspector](https://github.com/eclipse-cdt-cloud/vscode-memory-inspector) extension for vscode which is available from the [Microsoft Marketplace](https://marketplace.visualstudio.com/items?itemName=eclipse-cdt.memory-inspector) and the [Open VSX Registry](https://open-vsx.org/extension/eclipse-cdt/memory-inspector).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, better VS Code.
I believe we should at least say VS Code Marketplace (with or without Microsoft). Microsoft has other marketplaces as well, e.g. https://azuremarketplace.microsoft.com/de-de/

Copy link
Author

@GitMensch GitMensch Jan 23, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed, Microsoft talks about it as "Extension Marketplace" and "VS Code Marketplace"

Any feedback on these plans is welcomed in the discussion in GitHub issue [#110](https://github.com/eclipse-cdt-cloud/cdt-gdb-vscode/issues/110).

Expand Down
Loading